Readme-Helper
Snippets to help you create Readme files
Details
Installs
- Total 6K
- Win 2K
- Mac 2K
- Linux 1K
May 31 | May 30 | May 29 | May 28 | May 27 | May 26 | May 25 | May 24 | May 23 | May 22 | May 21 | May 20 | May 19 | May 18 | May 17 | May 16 | May 15 | May 14 | May 13 | May 12 | May 11 | May 10 | May 9 | May 8 | May 7 | May 6 | May 5 | May 4 | May 3 | May 2 | May 1 | Apr 30 | Apr 29 | Apr 28 | Apr 27 | Apr 26 | Apr 25 | Apr 24 | Apr 23 | Apr 22 | Apr 21 | Apr 20 | Apr 19 | Apr 18 | Apr 17 | |
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Windows | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 1 | 1 | 1 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 |
Mac | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 2 | 0 | 1 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 2 | 0 | 1 | 0 |
Linux | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 1 | 0 | 0 | 0 | 0 | 2 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Readme
- Source
- raw.githubusercontent.com
Readme Helper
Snippets for Sublime Text to speed up the process of writing Readme files, supporting Markdown, reStructuredText and Textile.
Installation
Package Control
- Make sure you already have Package Control installed
- Choose “Install Package” from the Command Palette (Super+Shift+p)
- Type “Readme Helper” and press Enter
GitHub
- Change to your Sublime Text
Packages
directory - Clone repository
git clone https://github.com/idleberg/Readme-Helper.git 'Readme Helper'
Manual installation
- Download the latest stable release
- Unzip the archive to your Sublime Text
Packages
directory
Usage
By default, command completion should be enabled in all Sublime Text versions. If the completion popup doesn't show while typing one of the following commands, you can force showing it using Ctrl+Space
or by adding the right scope to your user settings under auto_complete_selector
.
All command completions are prefixed with rm
. Thanks to Sublime Text fuzzy search, you can use shortcuts such as rmppl
to trigger rm-paypal
or rmsf
to trigger rm-sourceforge
.
See below for a full list of available commands.
Scaffolding
rm-scaffold_sublimetext
instructions for Sublime Text Package Control
rm-scaffold_grunt
instructions for a Grunt package
rm-scaffold_node
(very basic) instructions for the Node Package Manager
rm-scaffold_wordpress
a readme for a Wordpress plugin
Snippets
Licenses
Badges
Trigger | Badge | Example |
---|---|---|
rm-bitdeli |
BitDeli | |
rm-bower_version |
Bower | |
rm-cocoapod_version |
CocoaPod | |
rm-codeclimate |
Code Climate | n/a |
rm-coveralls |
Coverage | ![]() |
rm-cpan_version |
Perl | |
rm-david_dev |
devDepencies | |
rm-david |
Depencies | |
rm-flattr_icon |
Flattr (icon) | ![]() |
rm-flattr |
Flattr (badge) | |
rm-gem_version |
gem version | |
rm-github_follow_count |
GitHub (follow count) | |
rm-github_follow |
GitHub (follow button) | |
rm-github_fork_count |
GitHub (fork count) | |
rm-github_fork |
GitHub (fork) | |
rm-github_star_count |
GitHub (star count) | |
rm-github_star_large_count |
GitHub (large star count) | |
rm-github_star |
GitHub (star) | |
rm-github_version |
GitHub | |
rm-gitter |
Gitter | |
rm-grunt |
Grunt | ![]() |
rm-landscape |
Landscape | n/a |
rm-npm_version |
npm module | |
rm-nuget_version |
NuGet | |
rm-paypal |
Paypal | ![]() |
rm-php_version |
PHP | |
rm-pypi_version |
PyPI | |
rm-travis |
Travis |
To extend support for Shields.io badges, please install the Badges package!
URLs
Trigger | Target | Example |
---|---|---|
rm-bitbucket_repo |
Bitbucket repository | https://bitbucket.org/user/repository |
rm-github_repo |
GitHub repository | https://github.com/user/repository |
rm-github_user |
GitHub user profile | https://github.com/user |
rm-github_webpage |
GitHub web page | https://user.github.io/repository |
rm-gitorious_repo |
Gitorious repository | https://gitorious.org/user/repository |
rm-googlecode |
Google Code project | https://code.google.com/p/project |
rm-heroku_webpage |
Heroku web page | http://example.herokuapp.com |
rm-sourceforge_webpage |
SourceForge web page | http://example.sourceforge.net |
rm-sourceforge |
SourceForge project page | https://sourceforge.net/projects/example |
Contributions
If you'd like to contribute to this project, feel invited to commit to this repository!
License
This work is licensed under the The MIT License.
Donate
You are welcome support this project using Flattr or Bitcoin 17CXJuPsmhuTzFV2k4RKYwpEHVjskJktRd