add license file & testing/contrib info to readme

stevenosloan · Feb 28, 2014 · 1151ef20496e27b456a88c023e7fd1269836573b · 1151ef2
1 parent 3dd5d1e
commit 1151ef20496e27b456a88c023e7fd1269836573b
Unified Split

Showing with 54 additions and 5 deletions.

+6 −1 .gitignore

+20 −0 LICENSE

+1 −1 changelog.md

+25 −1 readme.md

+2 −2 slack-notifier.gemspec
diff --git a/.gitignore b/.gitignore
@@ -1,2 +1,7 @@
+  
+.DS_Store
 Gemfile.lock
-  
-*.gem
+  
+.rvmrc
+  
+.ruby-version
+  
+.ruby-gemset
+  
+*.gem
+  
+coverage
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,20 @@
+  
+The MIT License (MIT)
+  
+
+  
+Copyright (c) 2014 Steven Sloan
+  
+
+  
+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/changelog.md b/changelog.md
@@ -1,5 +1,5 @@
 # 0.1.0
-  
- now formats links in your message to match slack's format
+  
+- now formats html or markdown links in your message to match slack's format
 # 0.0.2
 - fix a fat finger if a default channel is set

diff --git a/readme.md b/readme.md
@@ -19,4 +19,28 @@ Slack requires links to be formatted a certain way, so slack-notifier will look
 message = "Hello world, [check](http://example.com) it <a href='http://example.com'>out</a>"
 Slack::Notifier::LinkFormatter.format(message)
 # => "Hello world, <http://example.com|check> it <http://example.com|out>"
-  
-```
+  
+```
+  
+
+  
+Testing
+  
+-------
+  
+
+  
+```bash
+  
+$ rspec
+  
+```
+  
+
+  
+
+  
+Contributing
+  
+------------
+  
+
+  
+If there is any thing you'd like to contribute or fix, please:
+  
+
+  
+- Fork the repo
+  
+- Add tests for any new functionality
+  
+- Make your changes
+  
+- Verify all new &existing tests pass
+  
+- Make a pull request
+  
+
+  
+
+  
+License
+  
+-------
+  
+The slack-notifier gem is distributed under the MIT License.
diff --git a/slack-notifier.gemspec b/slack-notifier.gemspec
@@ -6,8 +6,8 @@ Gem::Specification.new do |s|
  s.version       = Slack::Notifier::VERSION
  s.platform      = Gem::Platform::RUBY
-  
-  s.summary       = 'A simple wrapper for posting to slack channels'
-  
-  s.description   = %q{ A simple wrapper for posting to slack channels }
+  
+  s.summary       = 'A slim ruby wrapper for posting to slack channels'
+  
+  s.description   = %q{ A slim ruby wrapper for posting to slack channels }
  s.authors       = ["Steven Sloan"]
  s.email         = ["stevenosloan@gmail.com"]
  s.homepage      = "http://github.com/stevenosloan/slack-notifier"