summary refs log tree commit diff
path: root/docs
diff options
context:
space:
mode:
authorPatryk Niedźwiedziński <pniedzwiedzinski19@gmail.com>2019-10-14 09:47:28 +0200
committerPatryk Niedźwiedziński <pniedzwiedzinski19@gmail.com>2019-10-14 09:47:51 +0200
commit49e82e812812ba75175d98173379d2e416e17b8f (patch)
treef67bdcffce9aca8a76b534124a0eabbe85658768 /docs
parent262ebdc07892f3c892d4831c276444df6f6e22f1 (diff)
downloadkronikarz-49e82e812812ba75175d98173379d2e416e17b8f.tar.gz
kronikarz-49e82e812812ba75175d98173379d2e416e17b8f.zip
Add getPost
Diffstat (limited to 'docs')
-rw-r--r--docs/README.md5
1 files changed, 3 insertions, 2 deletions
diff --git a/docs/README.md b/docs/README.md
index 4b82b43..ebfdaa0 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -28,8 +28,9 @@ import Kronikarz from "kronikarz";
 const k = new Kronikarz("path/to/posts");
 ```
 
-At this point only one method is available.
+At this point only two methods are available.
 
 ```js
-k.getPosts();
+k.getPosts(); // returns array of all posts
+k.getPost("2019", "11", "20", "title"); // returns post from path `2019/11/20/title.md`
 ```