Skip to content
Browse files

Write documentation

  • Loading branch information...
1 parent ba24b56 commit c5d36f52303584a9d2f749586611d495dfcd5af2 @oscardelben committed Apr 7, 2012
Showing with 44 additions and 20 deletions.
  1. +42 −18 README.md
  2. +2 −2 Rakefile
View
60 README.md
@@ -1,31 +1,55 @@
-= sheet
+# Sheet
-Easily create and access sheets from your terminal.
-
-Note: sheet uses the $EDITOR variable to figure out how to open sheets
-(for writing).
+Easily create and access snippets of text from your terminal. `sheet` is
+your own personal wiki.
Examples:
+```
+sheet # with no arguments it will just list all your sheets
+sheet git # opens git sheet
+sheet new git # creates git sheet
+sheet edit git # edit git sheet
+```
- sheet git # opens git sheet
- sheet git 'undo commit' # opens git sheet, and searches for 'undo commit'
- sheet new git # creates git sheet
- sheet edit git # edit git sheet
-
-Once you open a sheet, you can write whatever you want into it.
+Use `sheet new <term>` to create your first sheet. Useful for jotting
+down commands that you use often but somehow never remember.
### Opening urls
-You can use the special format to automatically open a url:
+Found a great cheat sheet *online* about jquery or your favorite
+language? I've got you covered.
+
+When writing your snippet, you can use this special format to
+automatically open a url when opening your sheet:
+
+```
+url: http://example/com
+```
+
+Make sure that's you don't have trailing lines and sheet will
+automatically open that url for you
+
+Please note that to open urls, sheet will use the `open` command on mac
+os x and `xdg-open` in linux. Patches welcome for other systems.
+
+### Behind the scenes
+
+`sheet` stores your sheets in text files in the
+`~/.sheets` directory. You can go there and modify the files manually if you desire,
+or you can source them into version control and share them across
+multiple systems.
+
+For writing files, `sheet` looks for the `$EDITOR` global variable, and
+will raise an error if no editor was found.
- url: http://example/com
+### Help your stuff is broken
-Behind the scenes, sheet stores your sheets in txt files in the
-~/.sheets directory. You can go there and modify the files if you want.
+I tested this software in mac os x with Ruby 1.9. If you find any bug
+with other platforms/interpreters please let me know and I'll push a
+fix.
+### Contributing to sheet
-== Contributing to sheet
-
* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
* Fork the project.
@@ -34,7 +58,7 @@ Behind the scenes, sheet stores your sheets in txt files in the
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
-== Copyright
+### Copyright
Copyright (c) 2012 Oscar Del Ben. See LICENSE.txt for
further details.
View
4 Rakefile
@@ -17,8 +17,8 @@ Jeweler::Tasks.new do |gem|
gem.name = "sheet"
gem.homepage = "http://github.com/oscardelben/sheet"
gem.license = "MIT"
- gem.summary = %Q{TODO: one-line summary of your gem}
- gem.description = %Q{TODO: longer description of your gem}
+ gem.summary = %Q{snippets for your command line}
+ gem.description = %Q{sheets allows you to store and browse snippets of text from your command line.}
gem.email = "info@oscardelben.com"
gem.authors = ["Oscar Del Ben"]
# dependencies defined in Gemfile

0 comments on commit c5d36f5

Please sign in to comment.
Something went wrong with that request. Please try again.