+README and LICENSE

defunkt · Jun 22, 2012 · b7b56aa · b7b56aa
1 parent fb82c87
commit b7b56aa
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 0 deletions.
diff --git a/LICENSE.MIT b/LICENSE.MIT
@@ -0,0 +1,7 @@
+Copyright (c) 2012 Conrad Irwin <conrad.irwin@gmail.com>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY 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.
diff --git a/README.md b/README.md
@@ -0,0 +1,35 @@
+Jist is a gem that allows you to publish a [gist](https://gist.github.com) from Ruby.
+
+# Introduction
+
+Jist is a really simple library that wraps a single API call, you use it:
+
+```ruby
+Jist.gist("Look.at(:my => 'awesome').code")
+```
+
+If you need more advanced features you can also pass:
+
+* `:username` and `:password` to log in and post an authenticated gist.
+* `:filename` to change the syntax highlighting (default is `a.rb`).
+* `:public` if you want your hist to have a guessable url.
+* `:description` to add a description to your gist.
+
+Todo
+====
+
+It'd be nice to add a binary so that you can use it from your terminal. In the meantime you can use:
+
+```shell
+
+$ ruby -rjist -e'puts Jist.gist(ARGF.read)["html_url"]' <<EOF
+Look.at(:my => 'awesome').code
+EOF
+```
+
+Meta-fu
+=======
+
+I wrote this because the `gist` gem is out of action, and has been for many months.
+
+It's licensed under the MIT license, and bug-reports, and pull requests are welcome.