README.md in noty-0.1.0 vs README.md in noty-0.1.1
- old
+ new
@@ -18,11 +18,19 @@
### For Linux:
1. xsel : could be found on most distros official repositories
2. xdg-open : should be installed with most opendesktop compatible desktop environments
+## Environment
+by default Noty saves your files in `~/.notes` if you want to change that path, define an Environment variable in your shell init file `.bashrc` or `.zshrc`
+
+```bash
+export NOTES_PATH=/path/to/your/notes/dir
+```
+
+
## Usage
Snippets and bookmarks manager.
**Usage:**
@@ -33,9 +41,31 @@
**Input types:**
1. **url:** e.g "http://www.example.com", add URL as a bookmark file
2. **keyword:** search bookmarks and perform action on it, a single word of multiple words or regex, it is passed to "ag silver searcher"
3. **snippet text:** any multiword text, it will search first if no files contain this text you'll be asked if you want to create a snippet for it
+
+## Examples
+
+Add a bookmark
+```bash
+noty https://www.youtube.com
+```
+
+Search for bookmark
+```bash
+noty youtube
+```
+
+Add a snippet text
+```bash
+noty this is a long text that I need to save in my stash
+```
+
+Search for a snippet (same as searching for bookmarks)
+```bash
+noty need
+```
## Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/blazeeboy/noty.