Skip to content

Commit

Permalink
Add section for acknowledgement and contributions
Browse files Browse the repository at this point in the history
  • Loading branch information
suyashmahar committed Dec 24, 2017
1 parent 21693b4 commit 98729ca
Showing 1 changed file with 15 additions and 4 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,23 +14,28 @@ If you are using bash:
git clone https://github.com/suyashmahar/pine.git $HOME/pine && echo 'export PATH="$HOME/pine:$PATH"' >> $HOME/.bashrc && source $HOME/.bashrc
```

If you are using zsh:
```shell
git clone https://github.com/suyashmahar/pine.git $HOME/pine && echo 'export PATH="$HOME/pine:$PATH"' >> $HOME/.zshrc && source $HOME/.zshrc
```

Usage
-----
Pine uses extremely simple CLI for managing .gitignore files, to add a new configuration to your .gitignore file just pass the name of configuration as a parameter:
```shell
~ [my-git-rep] $ pine c java kotlin clojure # Install configuration for 'c', 'java', 'kotlin' and 'clojure'
[my-git-rep] $ pine c java kotlin clojure # Install configuration for 'c', 'java', 'kotlin' and 'clojure'
```

This would update the .gitignore file present in the same directory with new configurations.

To remove an existing configuration from `.gitignore` use `-r` or `--remove` switch:
```shell
~ [my-git-rep] $ pine -r c java # Removes configuration for 'c' and 'java' from .gitignore file
[my-git-rep] $ pine -r c java # Removes configuration for 'c' and 'java' from .gitignore file
```

Pine uses .gitignore files provided by GitHub, these files are often updated to fix bugs or add a new pattern. To update your local copy of gitignore files use `-u` or `--update` switch:
```shell
~ [my-git-rep] $ pine -u # Updates local repository of GitHub's gitignore files
[my-git-rep] $ pine -u # Updates local repository of GitHub's gitignore files
```

For complete help use `pine --help`.
Expand All @@ -39,8 +44,14 @@ Demo
----
[![asciicast](https://asciinema.org/a/JhrS2JOC5Ge5XVLmp3xOIQxZK.png)](https://asciinema.org/a/JhrS2JOC5Ge5XVLmp3xOIQxZK)

Installation
Uninstallation
--------------
Delete `~/pine` directory and remove the line `export PATH="$HOME/pine:$PATH"` from `~/.bashrc`.

Acknowledgment
--------------
Pine relies on following components:
* .gitignore collection by GitHub | [Github repository](https://github.com/github/gitignore)

# Contribution
Feel free to [file issues](https://github.com/suyashmahar/pine/issues) and submit [pull requests](https://github.com/suyashmahar/pine/pulls) - contributions are welcome.

0 comments on commit 98729ca

Please sign in to comment.