Skip to content

Commit 07245a9

Browse files
authored
fix: README.md
1 parent 65bf95e commit 07245a9

File tree

1 file changed

+12
-22
lines changed

1 file changed

+12
-22
lines changed

README.md

Lines changed: 12 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,16 @@
1-
# api-docs
1+
# ClassCharts API Docs
22

3-
This is a Next.js application generated with
4-
[Create Fumadocs](https://github.com/fuma-nama/fumadocs).
3+
Unofficial API documentation for ClassCharts.
54

6-
Run development server:
5+
## Development Commands
76

8-
```bash
9-
npm run dev
10-
# or
11-
pnpm dev
12-
# or
13-
yarn dev
14-
```
7+
All commands are run from the root of the project, from a terminal:
158

16-
Open http://localhost:3000 with your browser to see the result.
17-
18-
## Learn More
19-
20-
To learn more about Next.js and Fumadocs, take a look at the following
21-
resources:
22-
23-
- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
24-
features and API.
25-
- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
26-
- [Fumadocs](https://fumadocs.vercel.app) - learn about Fumadocs
9+
| Command | Action |
10+
| :------------------------- | :----------------------------------------------- |
11+
| `pnpm install` | Installs dependencies |
12+
| `pnpm dev` | Starts local dev server at `localhost:3000` |
13+
| `pnpm build` | Builds the docs site for production |
14+
| `pnpm start` | Starts the built site for production |
15+
| `pnpm generate` | Generates all OpenAPI schema defs into files |
16+
| `pnpm postbuild` | Generates indexs for Algolia |

0 commit comments

Comments
 (0)