besaid.zone
A CLI for scaffolding ATProto web applications
docs: update readme with more information about project
+11
-5
+11
-5
README.md
+11
-5
README.md
···
1
1
# create-atproto-app
2
2
3
+
This CLI is a thin wrapper on top of `create-vite` that adds starter code for working with the AT Protocol.
4
+
3
5
> [!WARNING]
4
6
> We are still working out the proper setups for all of the templates, there could be breaking changes!
5
-
6
-
This is a thin wrapper on top of `create-vite` that adds specific code for working with the AT Protocol.
7
7
8
8
## Getting Started
9
9
10
+
The easiest way to get started is to invoke the `init` command which will take you through a set of prompts to generate a starter app.
11
+
10
12
```bash
11
13
npx @nulfrost/create-atproto-app@latest init
12
14
```
13
15
14
-
or if you want to skip the prompts
16
+
If you already have an idea of the framework you want to use you can skip the prompts entirely with these command line options:
17
+
18
+
- `--name` - the name of your project
19
+
- `--framework` - framework is just the frontend library you would like to use. see [Supported Templates](#supported-templates) to see which frameworks are supported.
20
+
- `--variant` - which variant of the framework you'd like to use. for example, if you select react you'll have react router, tanstack router, next etc as options. see [Variants](#variants) for which variants are supported currently.
15
21
16
22
```bash
17
23
npx @nulfrost/create-atproto-app@latest init --name my-project --framework react --variant react-ts
18
24
```
19
25
20
-
Variants:
26
+
## Variants:
21
27
22
28
- `react-ts`
23
29
- `svelte-ts`
24
30
- `vanilla`
25
31
26
-
Supported templates:
32
+
## Supported templates
27
33
28
34
- [x] HTML + JavaScript
29
35
- [x] React + TypeScript