docs: improve documentation

README.md

@@ -1,3 +1,8 @@
 # Obsidian album creation
 
+## Build library
+run `npm run build` to build the library and `npm run watch` to also watch for changes.
+
+## Running the library
+run `npm run cli -- ` and add arguments. For example `npm run cli -- --help`.
 

packages/cli/README.md

@@ -1,11 +1,46 @@
-# cli
+# Obsidian album creation
 
-This library was generated with [Nx](https://nx.dev).
+Creates a printable PDF album from journal written in Obsidian.
 
-## Running unit tests
+## Command line arguments
+to see help type `npx obsidian-album --help`
 
-Run `nx test cli` to execute the unit tests via [Jest](https://jestjs.io).
+```bash
 
-## Running lint
+> [email protected] cli
+> node dist/packages/cli/src/cli create --help
 
-Run `nx lint cli` to execute the lint via [ESLint](https://eslint.org/).
+Usage: Obsidian PDF Album creator create [options] <target>
+
+Arguments:
+  target               target pdf path
+
+Options:
+  --verbose            output debug logs (default: false)
+  --debug              debug (default: false)
+  --vault <path>       the target name (default: "")
+  --subFolder <path>   A sub folder inside the vault to look in (default: "")
+  --filterBy <path>    A suffix to look for in file name (default: "")
+  --filterFrom <path>  Start date to include  (default: "")
+  --filterTo <path>    Last date to include (default: "")
+  --title <path>       the album name (default: "")
+  --coverImage <path>  the album cover image (default: "")
+  -h, --help           display help for command
+```
+
+## Features:
+- [x] Cover page with title and cover image.
+- [x] Glue adjacent paragraph and image galleries to avoid page break if possible.
+- [x] Create masonry galleries for adjacent images.
+- [x] Remove empty paragraphs.
+- [x] Keep beginning of a file in a new page.
+- [x] Add dot at the end of each parapraph.
+- [x] Remove empty section headers.
+- [x] Allow splitting of images into different galleries using `...` syntax.
+-
+
+## Backlog
+
+- [ ] Reduce images sizes to avoid huge PDF files.
+- [ ] LTR support
+- [ ] Configuration file and interactive inputs