update readme
This commit is contained in:
parent
874ce0bfe8
commit
17926064df
2 changed files with 20 additions and 1 deletions
5
.vscode/settings.json
vendored
Normal file
5
.vscode/settings.json
vendored
Normal file
|
@ -0,0 +1,5 @@
|
||||||
|
{
|
||||||
|
"cSpell.words": [
|
||||||
|
"kanban"
|
||||||
|
]
|
||||||
|
}
|
16
README.md
16
README.md
|
@ -1,3 +1,17 @@
|
||||||
# nelle.observer
|
# nelle.observer
|
||||||
|
|
||||||
the source for [nelle.observer](https://nelle.observer)
|
the source for [nelle.observer](https://nelle.observer)
|
||||||
|
|
||||||
|
## quick repo links
|
||||||
|
|
||||||
|
[kanban](https://git.nullafati.xyz/limepotato/nelle-observer/projects/1)
|
||||||
|
|
||||||
|
## build/use
|
||||||
|
|
||||||
|
1. clone the repo
|
||||||
|
2. run `npm i` or `pnpm i`
|
||||||
|
3. `npm run dev` to run a dynamic preview or `npm run build` to build the static site.
|
||||||
|
4. once the static site is built, the output will be in `/dist`
|
||||||
|
|
||||||
|
|
||||||
|
## ~~[license](./)~~ TODO
|
Loading…
Reference in a new issue