aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorJulien Nicoulaud <julien.nicoulaud@gmail.com>2018-10-13 22:52:19 +0200
committerJulien Nicoulaud <julien.nicoulaud@gmail.com>2018-10-13 23:07:50 +0200
commit2a1350a60d963df18aabc70c5782ba96bc73fdf4 (patch)
tree23a9525c9b1640794ab65a2bb6878e524b7874ce /README.md
parentMerge pull request #594 from mikkeloscar/update-golang-111 (diff)
downloadzsh-completions-2a1350a60d963df18aabc70c5782ba96bc73fdf4.tar
zsh-completions-2a1350a60d963df18aabc70c5782ba96bc73fdf4.tar.gz
zsh-completions-2a1350a60d963df18aabc70c5782ba96bc73fdf4.tar.bz2
zsh-completions-2a1350a60d963df18aabc70c5782ba96bc73fdf4.tar.lz
zsh-completions-2a1350a60d963df18aabc70c5782ba96bc73fdf4.tar.xz
zsh-completions-2a1350a60d963df18aabc70c5782ba96bc73fdf4.tar.zst
zsh-completions-2a1350a60d963df18aabc70c5782ba96bc73fdf4.zip
#591: move CONTRIBUTING to root directory, README cleanup
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 3 insertions, 17 deletions
diff --git a/README.md b/README.md
index 70615cc..4a8b498 100644
--- a/README.md
+++ b/README.md
@@ -6,11 +6,6 @@ zsh-completions ![GitHub release](https://img.shields.io/github/release/zsh-user
*This projects aims at gathering/developing new completion scripts that are not available in Zsh yet. The scripts may be contributed to the Zsh project when stable enough.*
-## Status
-
-See [issues](https://github.com/zsh-users/zsh-completions/issues) for details on each completion definition.
-
-
## Usage
### Using packages
@@ -59,18 +54,9 @@ Add `antigen bundle zsh-users/zsh-completions` to your `~/.zshrc`.
### Contributing
-Contributions are welcome, just make sure you follow the guidelines:
-
- * Completions are not accepted when already available in zsh.
- * Completions are not accepted when already available in their original project.
- * Please do not just copy/paste someone else completion, ask before.
- * Completions only partially implemented are not accepted.
- * Please add a header containing authors, status and origin of the script and license header if you do not wish to use the Zsh license (example [here](src/_ack)).
- * Please try to follow [Zsh completion style guide](https://github.com/zsh-users/zsh/blob/master/Etc/completion-style-guide).
- * Please send one separate pull request per file.
- * Send a pull request or ask for committer access.
+Contributions are welcome, see [CONTRIBUTING](https://github.com/zsh-users/zsh-completions/blob/master/CONTRIBUTING.md).
## License
-Completions use the Zsh license, unless explicitely mentionned in the file header.
-See [LICENSE](https://github.com/zsh-users/zsh-completions/blob/master/LICENSE) for more information.
+Completions use the Zsh license, unless explicitly mentioned in the file header.
+See [LICENSE](https://github.com/zsh-users/zsh-completions/blob/master/LICENSE) for more information. \ No newline at end of file