summary refs log tree commit diff
path: root/docs/README.md
diff options
context:
space:
mode:
authorPatryk Niedźwiedziński <pniedzwiedzinski19@gmail.com>2020-01-28 18:08:07 +0100
committerPatryk Niedźwiedziński <pniedzwiedzinski19@gmail.com>2020-01-28 18:08:07 +0100
commit4b758eb6dd702c42c192322da87301bbef454838 (patch)
treedd2f2993b4ca365720c6254435189343015c18e9 /docs/README.md
parent1a5e99c7972968cc384c8dd94bbb92f9c9beac3b (diff)
downloadkronikarz-4b758eb6dd702c42c192322da87301bbef454838.tar.gz
kronikarz-4b758eb6dd702c42c192322da87301bbef454838.zip
Update docs
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md34
1 files changed, 32 insertions, 2 deletions
diff --git a/docs/README.md b/docs/README.md
index ebfdaa0..4c356bd 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -28,9 +28,39 @@ import Kronikarz from "kronikarz";
 const k = new Kronikarz("path/to/posts");
 ```
 
-At this point only two methods are available.
+### Generating the api
+
+For generating the json api run:
+
+```js
+k.generateApi(`./path`)
+```
+
+This will create all posts list in `./path/api/posts.json` and create json file
+with content for every markdown file in
+`./path/api/posts/{year}/{month}/{day}/{title}.json`.
+
+Also you can specify categories (tags) like this in your post:
+
+```md
+---
+title: Test
+author: Tester
+category:
+    - testing
+---
+```
+
+And it will generate list of all posts in this category in
+`./path/api/category/testing.json`
+
+### Old functions
+
+Now these function will return wrapper of `Post` object. If you want to get a
+simple object like from json api run `post.toApi()`
 
 ```js
 k.getPosts(); // returns array of all posts
-k.getPost("2019", "11", "20", "title"); // returns post from path `2019/11/20/title.md`
+let post = k.getPost("2019", "11", "20", "title"); // returns post from path `2019/11/20/title.md`
+post.toApi();
 ```