diff --git a/LICENSE.md b/LICENSE.md index 63b4b68..5ba264e 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ MIT License -Copyright (c) [year] [fullname] +Copyright (c) 2025 Ronan Berder Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/packages/cli/README.md b/packages/cli/README.md new file mode 100644 index 0000000..0281c8a --- /dev/null +++ b/packages/cli/README.md @@ -0,0 +1,56 @@ +# basecoat-cli + +This package provides a Command Line Interface (CLI) to help you quickly scaffold [Basecoat](https://basecoatui.com) components into your project. + +## Prerequisites + +- Ensure you have Node.js and npm (or your preferred package manager) installed. +- For the components to function correctly, your project should have: + - [Tailwind CSS](https://tailwindcss.com/docs/installation) installed and configured. + - The `basecoat-css` package installed and imported (or `basecoat.css` manually added). + - [Alpine.js](https://alpinejs.dev/docs/installation) installed and initialized, as Basecoat components rely on it for interactivity. + +## Usage + +Use the `add` command to add components to your project: + +```bash +# npx +npx basecoat-cli add [component] + +# pnpm +pnpm dlx basecoat-cli add [component] + +# bun +bunx basecoat-cli add [component] + +# yarn +yarn dlx basecoat-cli add [component] +``` + +Replace `[component]` with the name of the component you wish to add (e.g., `dialog`, `select`) or leave it out if you want to pick from the list of available components +or install all of them at once. + +The CLI will prompt you for: + +1. **Template Engine:** Choose between Nunjucks (`.njk`) or Jinja (`.html.jinja`). +2. **Assets Directory:** The path where component assets (like JavaScript files) should be placed (e.g., `src/assets/js/components`). +3. **Macros Directory:** The path where component macros should be placed (e.g., `src/_includes/macros/components`). + +The CLI will then copy the necessary JavaScript files and Nunjucks/Jinja macros for the selected component into the specified directories. + +### Example + +To add the `dialog` component: + +```bash +npx basecoat-cli add dialog +``` + +## Documentation + +For more detailed information on components, their usage, and customization options, please refer to the [Basecoat documentation](https://basecoatui.com/installation/#install-cli). + +## License + +[MIT](https://github.com/hunvreus/basecoat/blob/main/LICENSE.md) \ No newline at end of file diff --git a/packages/css/README.md b/packages/css/README.md new file mode 100644 index 0000000..86da733 --- /dev/null +++ b/packages/css/README.md @@ -0,0 +1,54 @@ +# basecoat-css + +This package provides the core CSS styles for [Basecoat](https://basecoatui.com), a component library built with Tailwind CSS. + +## Prerequisites + +Your project must have [Tailwind CSS](https://tailwindcss.com/docs/installation) installed and configured, as Basecoat relies on Tailwind utility classes and theming. + +## Installation + +You can install `basecoat-css` using your preferred package manager: + +```bash +# npm +npm install basecoat-css + +# yarn +yarn add basecoat-css + +# pnpm +pnpm add basecoat-css + +# bun +bun add basecoat-css +``` + +Alternatively, you can download the `basecoat.css` file directly from the [GitHub repository](https://github.com/hunvreus/basecoat/blob/main/src/css/basecoat.css) (or the `dist/basecoat.css` file from this package after installation) and include it in your project. + +## Usage + +After installation, import `basecoat-css` into your main CSS file. Make sure to import it **after** Tailwind CSS and **before** any custom theme overrides. + +```css +/* Your main CSS file (e.g., styles.css) */ + +@import "tailwindcss/base"; +@import "tailwindcss/components"; +@import "tailwindcss/utilities"; + +@import "basecoat-css"; /* Or the path to basecoat.css if manually added */ + +/* Your custom styles or theme overrides (optional) */ +/* @import "your-theme.css"; */ +``` + +Once imported, you can start using Basecoat's component classes in your HTML. + +## Documentation + +For more detailed information on components, their usage, and customization options, please refer to the [Basecoat documentation](https://basecoatui.com/installation/#install-css). + +## License + +[MIT](https://github.com/hunvreus/basecoat/blob/main/LICENSE.md) \ No newline at end of file