summary refs log tree commit diff
path: root/docs/README.md
diff options
context:
space:
mode:
authorPatryk Niedźwiedziński <pniedzwiedzinski19@gmail.com>2019-10-14 00:13:47 +0200
committerPatryk Niedźwiedziński <pniedzwiedzinski19@gmail.com>2019-10-14 00:13:47 +0200
commit949e73c52250a9b26e655d8a6c3ccc138dfb00cc (patch)
treed35149f3e8d1f3de38e9abbe781a2636004f6dda /docs/README.md
parent4274595b251632ef004d5f1429d7fbdde1cd4a5a (diff)
downloadkronikarz-949e73c52250a9b26e655d8a6c3ccc138dfb00cc.tar.gz
kronikarz-949e73c52250a9b26e655d8a6c3ccc138dfb00cc.zip
Add documentation
Diffstat (limited to 'docs/README.md')
-rw-r--r--docs/README.md28
1 files changed, 22 insertions, 6 deletions
diff --git a/docs/README.md b/docs/README.md
index 616fbb7..8109cca 100644
--- a/docs/README.md
+++ b/docs/README.md
@@ -1,19 +1,35 @@
 # Kronikarz
 
-Required folder structure:
+Kronikarz is a file based system for managing blog posts. It's original purpose was to have an universal way for creating chronicles of scouting troops. But it's not only for scouts 😉.
 
+## Getting started
+
+Kronikarz has it's own rule for managing posts and at this point it is hard-coded. Required folder structure looks like this:
+
+```
+your_folder
+└── {year}
+    └── {month}
+        └── {title}
+            └── {title}.md
 ```
-year
-└── month
-    └── title
-        └── title.md
+
+Firstly install kronikarz with npm
+
+```bash
+npm install kronikarz
 ```
 
-To parse all posts run:
+To use kronikarz you need to initialize it first with path to folder where all your posts are. If look at the example above it would be path to `your_folder`. You need to remember that when you run a script with npm current working directory is always root directory.
 
 ```js
 import Kronikarz from "kronikarz";
 
 const k = new Kronikarz("path/to/posts");
+```
+
+At this point only one method is available.
+
+```js
 k.getPosts();
 ```