diff --git a/README.md b/README.md index bfc4946..ca5ea53 100644 --- a/README.md +++ b/README.md @@ -2,13 +2,13 @@ A [Sublime Text 2](http://www.sublimetext.com/) plugin to automate adding the appropriate copyright text at the top of every file. -# Compatibility +## Compatibility AutoCopyright is only compatible with Sublime Text 2 at this time. We have plans for upgrading it to support Sublime Text 3 when possible. -# Installation +## Installation -## Package Control +### Package Control The awesome Package Control package is a great way to easily install and manage Sublime Text 2 packages. @@ -17,13 +17,15 @@ The awesome Package Control package is a great way to easily install and manage 1. Type PCIP (for Package Control: Install Package) and press Return 1. Type AutoCopyright and press Return -## Manual installation +### Manual installation Go to the "Packages" directory (`Preferences` / `Browse Packages...`). Then clone this repository: - git clone git://github.com/lifted-studios/AutoCopyright +```sh +$ git clone git://github.com/lifted-studios/AutoCopyright +``` -# Options +## Options Edit the settings file (it should open automatically the first time you use an Auto Copyright command): @@ -43,19 +45,19 @@ Edit the settings file (it should open automatically the first time you use an A This is the amount of padding around the line that contains the copyright. The default is one line above and below the copyright line. -# Usage +## Usage Two functions will show up in the Command Palette under "Auto Copyright". Additionally, the Update Copyright command will automatically be called just before any file is saved. -## Insert Copyright +### Insert Copyright Adds the copyright text to the beginning of the file. It will add itself after a [shebang line](http://en.wikipedia.org/wiki/Shebang), if any. When the command is triggered, if there are multiple copyright owners configured in settings, it will pop up a list and ask which one to use. -## Update Copyright +### Update Copyright Updates the copyright text already present in the file, but only if the text matches, including the copyright owner name except for the year. It will update the copyright year to include all years between the original year and this one. The command will update the copyright text for any of the configured owner texts. -# Information +## Information Source: https://github.com/lifted-studios/AutoCopyright