diff options
Diffstat (limited to 'docs/README.md')
-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(); +``` |