Skip to content

Commit

Permalink
docs(readme): update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
neptship committed Dec 14, 2023
1 parent 7ea63fb commit e09d8ef
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
24 changes: 22 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
<img alt="goreportcard" src="https://goreportcard.com/badge/github.com/neptunsk1y/ignore"
/></a>
<a href="https://github.com/neptunsk1y/radiorecord/actions/workflows/test.yml">
<img alt="test workflow" src="https://github.com/neptunsk1y/goradio/actions/workflows/test.yml/badge.svg"
<img alt="test workflow" src="https://github.com/neptunsk1y/ignore/actions/workflows/test.yml/badge.svg"
/></a>
<a href="https://github.com/neptunsk1y/ignore/blob/main/LICENSE">
<img alt="license" src="https://img.shields.io/github/license/neptunsk1y/ignore"
Expand All @@ -23,7 +23,9 @@

- Fast
- Cross-Platform - Linux, macOS, Windows
- A large number of templates
- Easy installation
- More than 600 templates for different technologies
- Friendly error messages in case something goes wrong

<h2>Installation</h2>

Expand Down Expand Up @@ -64,6 +66,24 @@ go install

</details>

<h2>Usage</h2>

![Usage](https://github.com/neptunsk1y/ignore/blob/main/assets/ignore.gif?raw=true)

<h3>Other</h3>

See `ignore help` for more information

<details>
<summary>Commands</summary>

| Name | Description |
|--------------|---------------------------------------|
| create | create .ignore file |
| add | add a template to .ignore file |
| list | available templates for .ignore files |
</details>

<h2> Built With </h2>

* [Cobra](https://cobra.dev/) - The modern CLI framework used
Expand Down
Binary file added assets/ignore.gif
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 e09d8ef

Please sign in to comment.