Skip to content

Commit 5f7847a

Browse files
authored
docs: readme
1 parent 7740ce1 commit 5f7847a

File tree

1 file changed

+16
-3
lines changed

1 file changed

+16
-3
lines changed

README.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,18 @@
11
# Jwc.js Documentation
22

3-
<pre align="center">
4-
🧪 Working in Progress
5-
</pre>
3+
## Contributing
4+
5+
This site is built by VitePress with default theme. Document is written in Markdown format located in `docs`. You can directly edit the file on GitHub and open a Pull Request for simple edit.
6+
7+
In local development, you should use `pnpm` as package manager:
8+
9+
```bash
10+
pnpm i
11+
pnpm run dev
12+
```
13+
14+
## License
15+
16+
[MIT](https://opensource.org/licenses/MIT)
17+
18+
Copyright © 2022-PRESENT Jwc.js

0 commit comments

Comments
 (0)