diff options
| author | Patryk Niedźwiedziński <pniedzwiedzinski19@gmail.com> | 2019-10-13 22:47:37 +0200 |
|---|---|---|
| committer | Patryk Niedźwiedziński <pniedzwiedzinski19@gmail.com> | 2019-10-13 22:47:37 +0200 |
| commit | 241ceeba4ad203b1e0711490344e970a3a452d07 (patch) | |
| tree | eab68a6b859c8e8804ddf5d989f9582c3724153f /docs | |
| parent | 590a6776063807be20f8cfaf2de9059bbbc559c1 (diff) | |
| download | kronikarz-241ceeba4ad203b1e0711490344e970a3a452d07.tar.gz kronikarz-241ceeba4ad203b1e0711490344e970a3a452d07.zip | |
Add simple parsing
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/README.md | 18 |
1 files changed, 18 insertions, 0 deletions
diff --git a/docs/README.md b/docs/README.md index 76d000e..616fbb7 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1 +1,19 @@ # Kronikarz + +Required folder structure: + +``` +year +└── month + └── title + └── title.md +``` + +To parse all posts run: + +```js +import Kronikarz from "kronikarz"; + +const k = new Kronikarz("path/to/posts"); +k.getPosts(); +``` |