Skip to content

Commit

Permalink
docs: update README.md and CHANGELOG.md
Browse files Browse the repository at this point in the history
  • Loading branch information
neptship committed Jul 2, 2024
1 parent 98bfa1d commit 571b52c
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 31 deletions.
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,12 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com), and this project adheres to
[Semantic Versioning](https://semver.org).

## v2.0.0

- A new interface using PromptUI
- Simplifying the cli
- Сhanging the structure

## v1.6.1

- chore: migration from `neptunsk1y` to `neptship`
Expand Down
33 changes: 2 additions & 31 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,44 +45,15 @@ Clone the repo
```shell
git clone https://github.com/neptship/ignore.git
cd ignore
```

GNU Make **(Recommended)**
```shell
make setup # if you want to compile and install ignore cli to path
```

<details>
<summary>If you don't have GNU Make use this</summary>


```shell
# To build
go build

# To install
go install
```

</details>

<h2>Usage</h2>

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

<h3>Other</h3>
Just run `ignore` and you're ready to go.

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>
![Usage](https://github.com/neptship/ignore/blob/main/assets/ignore.gif?raw=true)

<h2> Built With </h2>

Expand Down
Binary file modified 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 571b52c

Please sign in to comment.