Skip to content

Commit

Permalink
docs: update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
mehran-prs committed May 19, 2024
1 parent 4175d3a commit 687c32c
Show file tree
Hide file tree
Showing 6 changed files with 8 additions and 4 deletions.
12 changes: 8 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<p align="center">
<img width="250" src="./docs/images/snip_logo.png" alt="snip logo"/>
</p>

<p align="center">
<a href="https://goreportcard.com/report/github.com/mehran-prs/snip">
<img src="https://goreportcard.com/badge/github.com/mehran-prs/snip">
Expand All @@ -16,7 +20,7 @@ Snip is a command-line snippet manager.
### Features

- View your snippets on command line.
- Manage(create|edit|View|Delete) your snippets using your favorite editor.
- Manage (create|edit|Delete) your snippets using your favorite editor.
- Auto-completion on the command-line for your snippet names (supports `bash`, `zsh`, `fish` and `powershell`).
- Seamlessly integration with `fzf` to fuzzy find your snippets.
- Render your snippets nicely (you can set your custom commands to render files)
Expand All @@ -34,15 +38,15 @@ Snip helps you manage snippets in cmd.
you bash or zsh,
you can find snippets by fuzzy search by typing `**` and pressing tab.

![snip view snippets](./docs/screenshots/snip-view.gif)
![snip view snippets](docs/images/snip-view.gif)

#### Edit snippets (Create|Update|Delete)

- Run `snip edit` to open your snippets repository in your favorite editor.
- Run `snip edit {snippet_path}` to create|edit your snippet in your favorite editor.
- Run `snip rm {snippet_path}` to remove a snippet. (use `-r` flag to remove recursively)

![snip edit snippets](./docs/screenshots/snip-edit.gif)
![snip edit snippets](docs/images/snip-edit.gif)

### Sync snippets changes with your remote git repository

Expand All @@ -56,7 +60,7 @@ git commit -m "{users_provided_message | default_message}"
git push origin
```

![snip sync snippets](./docs/screenshots/snip-sync.gif)
![snip sync snippets](docs/images/snip-sync.gif)


__Note__: before running `git sync` command for first time, you need to initialize git in your snippets directory and
Expand Down
File renamed without changes
File renamed without changes
File renamed without changes
Binary file added docs/images/snip_logo.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/snip_logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 687c32c

Please sign in to comment.