Skip to content

Commit ba44c67

Browse files
author
phernandez
committed
chore: update intallation docs and README
1 parent 6e5ef7d commit ba44c67

File tree

3 files changed

+27
-12
lines changed

3 files changed

+27
-12
lines changed

README.md

Lines changed: 22 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,44 @@ Built with JinjaX, Alpine.js, and Tailwind CSS, with support for htmx.
77

88
### Quick Start with `uvx`
99

10-
You can use the CLI directly without installing the package:
10+
JinjaX is required.
11+
12+
```bash
13+
# install jinjax
14+
uvx add jinjax
15+
````
16+
17+
You can use the CLI directly without installing the package.
1118

1219
```bash
1320
# Add components
1421
uvx --from basic-components components add button
1522
```
1623

1724
You will also need to configure your project to load components into the `jinjax.Catalog` and add a global `cn` function
18-
to the Jinja environment. See [utilities](docs/content/docs/utilities.md)
25+
to the Jinja environment. See [utilities](https://components.basicmachines.co/docs/utilities).
26+
27+
Helpers for these are packed in the `basic-components[utils]` package.
1928

2029
### Package Installation Options
2130

22-
Install only the utility functions for JinjaX and tailwind:
31+
Install only the utility functions for JinjaX and tailwind.
2332

2433
```bash
2534
# With utility functions
2635
pip install basic-components[utils]
2736
```
2837

38+
Setup instructions and examples:
39+
- [FastAPI](https://components.basicmachines.co/docs/fastapi)
40+
- [Flask](https://components.basicmachines.co/docs/flask)
41+
- [Django](https://components.basicmachines.co/docs/django)
42+
43+
2944
### Installation Groups
3045

3146
- `utils`: Utility functions for JinjaX setup and `cn()` tailwind class helper
32-
- `docs`: Runs the docs site
47+
- `docs`: Requirements for the docs site
3348
- `dev`: Development tools for contributing
3449
- `full`: All features included
3550
@@ -51,7 +66,7 @@ Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.
5166
5267
- [x] accordion
5368
- [x] alert
54-
- [x] alert-dialog -- example cancel/action
69+
- [x] alert-dialog
5570
- [ ] aspect-ratio
5671
- [ ] avatar
5772
- [x] badge
@@ -65,7 +80,7 @@ Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.
6580
- [ ] collapsible
6681
- [ ] command
6782
- [ ] context-menu
68-
- [x] dialog -- examples
83+
- [x] dialog
6984
- [ ] drawer
7085
- [x] dropdown-menu
7186
- [x] form
@@ -100,4 +115,4 @@ Licensed under the [MIT license](https://github.com/shadcn/ui/blob/main/LICENSE.
100115
- [ ] tooltip
101116
102117
Extended
103-
- [ ] Prose - https://docs.astro.build/en/recipes/tailwind-rendered-markdown/#recipe
118+
- [ ] Prose

docs/content/docs/installation.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ directory of the project. Components should be added via the [cli](/docs/cli).
2828

2929
<Card>
3030
<CardTitle className="mt-4 ml-6 text-sm">
31-
Note
31+
NOTE
3232
</CardTitle>
3333
<CardDescription className="my-2 ml-6">
3434
Using `uv` is optional
@@ -44,12 +44,12 @@ extra dependency.
4444

4545
<Alert variant="destructive">
4646
<CircleAlertIcon className="mr-2 h-4 w-4"/>
47-
<AlertTitle>You must</AlertTitle>
47+
<AlertTitle>IMPORTANT</AlertTitle>
4848
<AlertDescription>
4949

50-
- You must configure the `jinjax.Catalog` to load components from the directories under your `components` dir.
50+
You must configure the `jinjax.Catalog` to load components from the directories under your `components` dir.
5151

52-
- Add the `cn` global function so it is available to all Jinja templates.
52+
Also add the `cn` global function so it is available to all Jinja templates.
5353
</AlertDescription>
5454
</Alert>
5555

docs/site_config.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -73,7 +73,7 @@ def load_icons(json_path: str) -> List[SVGIcon]:
7373
{
7474
"title": "Installation",
7575
"items": [
76-
{"title": "Fastapi", "href": "/docs/fastapi"},
76+
{"title": "FastAPI", "href": "/docs/fastapi"},
7777
{"title": "Flask", "href": "/docs/flask"},
7878
{"title": "Django", "href": "/docs/django"},
7979
{"title": "Utilities", "href": "/docs/utilities"},

0 commit comments

Comments
 (0)