Permalink
Browse files

update readme

  • Loading branch information...
1 parent 511c9fa commit 54a64d66a449df47a72991977ef9cfac24abe364 @robin committed Feb 8, 2011
Showing with 10 additions and 10 deletions.
  1. +9 −9 README.markdown → README.rdoc
  2. +1 −1 chit.gemspec
@@ -1,12 +1,12 @@
-# Chit
+= Chit
http://github.com/robin/chit
-## DESCRIPTION:
+== DESCRIPTION:
Chit is a command line cheat sheet utility based on git.
-## FEATURES:
+== FEATURES:
Chit was inspired by 'cheat' (http://cheat.errtheblog.com/) by Chris Wanstrath. You can use chit to access and manage cheat sheets easily.
@@ -17,7 +17,7 @@ There are several differences between ‘cheat’ and ‘chit’. By using chit,
3. Directory support. You can group cheat sheets by directory now.
4. One less letter to type.
-## SYNOPSIS:
+== SYNOPSIS:
To initialize chit repositories
@@ -73,13 +73,13 @@ To move or rename a sheet, use '--mv/-m' switch
$ chit zsh_if zsh/if -m
-## INSTALL:
+== INSTALL:
sudo gem install chit
chit --init
-## CONFIGURATION:
+== CONFIGURATION:
Before run 'chit', you may want to config ~/.chitrc which is a YAML file.
@@ -91,12 +91,12 @@ want to add a new one.
* private:
* clone-from: where to get the private cheat sheets. If not specified, a new git repository will be init for private cheat sheets.
-## REQUIREMENTS:
+== REQUIREMENTS:
* rubygems
* git
-## LICENSE:
+== LICENSE:
This software is shared by MIT License
@@ -121,7 +121,7 @@ CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
-## BY:
+== BY:
Robin Lu
View
@@ -11,7 +11,7 @@ Gem::Specification.new do |s|
s.description = %q{Chit is A command line tool for cheat sheet utility based on git.}
s.email = ["iamawalrus@gmail.com"]
s.executables = ["chit"]
- s.extra_rdoc_files = ["Manifest.txt", "README.txt"]
+ s.extra_rdoc_files = ["Manifest.txt", "README.rdoc"]
s.files = ["Manifest.txt", "README.txt", "Rakefile", "bin/chit", "lib/chit.rb", "lib/wrap.rb", "resources/chitrc", "test/test_chit.rb"]
s.has_rdoc = true
s.homepage = %q{http://github.com/robin/chit}

0 comments on commit 54a64d6

Please sign in to comment.