Permalink
Browse files

added README.md

  • Loading branch information...
1 parent b8726e0 commit f303aa41bfdd0aa7b9329be45d4f7a0450dca11b @banister committed Dec 1, 2012
Showing with 38 additions and 1 deletion.
  1. +37 −0 README.md
  2. +1 −1 pry-note.gemspec
View
@@ -0,0 +1,37 @@
+Pry-note
+========
+
+__Ease refactoring and exploration by attaching notes to methods and classes in Pry__
+
+```
+[1] pry(main)> note -h
+ add
+ -m, --message Provide the note inline (without opening an editor).
+
+ show
+ -v, --verbose Show all notes together with source code.
+
+ list
+ -v, --verbose List all notes and content with source code.
+
+ delete
+ --all Delete all notes.
+
+ edit
+ -m, --message Update the note inline (without opening an editor).
+
+ Other options
+Usage: note [OPTIONS]
+Add notes to classes and methods.
+
+e.g note -a Pry#repl "this is my note" #=> add a note without opening editor
+e.g note -a Pry#repl #=> add a note (with editor) to Pry#repl method
+e.g note -d Pry#repl:1 #=> delete the 1st note from Pry#repl
+e.g note -d Pry#repl #=> delete all notes from Pry#repl
+e.g note -l #=> list all notes
+
+ -h, --help Show this message.
+```
+
+
+See the following showterm for an example session: http://showterm.io/c194f02da5545e9210cb9#fast
View
@@ -9,7 +9,7 @@ Gem::Specification.new do |s|
s.date = "2012-12-01"
s.description = "Ease refactoring and exploration by attaching notes to methods and classes in Pry"
s.email = "jrmair@gmail.com"
- s.files = ["Rakefile", "lib/pry-note.rb", "lib/pry-note/commands.rb", "lib/pry-note/hooks.rb", "lib/pry-note/version.rb", "test/helper.rb", "test/test_pry_note.rb"]
+ s.files = ["Rakefile", "lib/pry-note.rb", "lib/pry-note/commands.rb", "lib/pry-note/hooks.rb", "lib/pry-note/version.rb", "pry-note.gemspec", "test/helper.rb", "test/test_pry_note.rb"]
s.homepage = "https://github.com/banister"
s.require_paths = ["lib"]
s.rubygems_version = "1.8.23"

0 comments on commit f303aa4

Please sign in to comment.