diff options
author | Patryk Niedźwiedziński <pniedzwiedzinski19@gmail.com> | 2019-10-14 00:13:47 +0200 |
---|---|---|
committer | Patryk Niedźwiedziński <pniedzwiedzinski19@gmail.com> | 2019-10-14 00:13:47 +0200 |
commit | 949e73c52250a9b26e655d8a6c3ccc138dfb00cc (patch) | |
tree | d35149f3e8d1f3de38e9abbe781a2636004f6dda | |
parent | 4274595b251632ef004d5f1429d7fbdde1cd4a5a (diff) | |
download | kronikarz-949e73c52250a9b26e655d8a6c3ccc138dfb00cc.tar.gz kronikarz-949e73c52250a9b26e655d8a6c3ccc138dfb00cc.zip |
Add documentation
-rw-r--r-- | docs/README.md | 28 | ||||
-rw-r--r-- | lib/getPosts.ts | 1 |
2 files changed, 22 insertions, 7 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(); ``` diff --git a/lib/getPosts.ts b/lib/getPosts.ts index 4170292..69a353f 100644 --- a/lib/getPosts.ts +++ b/lib/getPosts.ts @@ -1,4 +1,3 @@ -import * as fs from "fs"; import { Post } from "./interfaces"; import parsePost from "./parsePost"; import { readDir } from "./utils"; |