Readme Helper

Snippets for Sublime Text to speed up the process of writing Readme files, supporting Markdown, reStructuredText and Textile.

Installation

Package Control

1. Make sure you already have Package Control installed
2. Choose “Install Package” from the Command Palette (Super+Shift+p)
3. Type “Readme Helper” and press Enter

GitHub

1. Change to your Sublime Text Packages directory
2. Clone repository git clone https://github.com/idleberg/Readme-Helper.git 'Readme Helper'

Manual installation

1. Download the latest stable release
2. 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

Trigger	License
rm-apache	Apache License, Version 2.0
rm-bsd2	BSD 2-Clause License
rm-bsd3	BSD 3-Clause License
rm-ccby3	Creative Commons Attribution 3.0 Unported License
rm-cc0	Creative Commons CC0 1.0 Universal
rm-ccby4	Creative Commons Attribution 4.0 Unported License
rm-ccbync3	Creative Commons Attribution-NonCommercial 3.0 Unported License
rm-ccbync4	Creative Commons Attribution-NonCommercial 4.0 Unported License
rm-ccbyncnd3	Creative Commons Attribution-NonCommercial-NoDerivs 3.0 Unported License
rm-ccbyncnd4	Creative Commons Attribution-NonCommercial-NoDerivs 4.0 Unported License
rm-ccbyncsa3	Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License
rm-ccbyncsa4	Creative Commons Attribution-NonCommercial-ShareAlike 4.0 Unported License
rm-ccbynd3	Creative Commons Attribution-NoDerivs 3.0 Unported License
rm-ccbynd4	Creative Commons Attribution-NoDerivs 4.0 Unported License
rm-ccbysa3	Creative Commons Attribution-ShareAlike 3.0 Unported License
rm-ccbysa4	Creative Commons Attribution-ShareAlike 4.0 Unported License
rm-afferogpl3	GNU Affero General Public License 3.0
rm-gpl2	GNU General Public License 2.0
rm-gpl3	GNU General Public License 3.0
rm-lgpl2	GNU Lesser General Public License 2.1
rm-ofl10	SIL Open Font License 1.0
rm-ofl11	SIL Open Font License 1.1
rm-mit	The MIT License
rm-zlib	The zlib/libpng License

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