Merge pull request #4 from mntnr/feat/audit-edits

Documentation changes

CONTRIBUTING.md

@@ -0,0 +1,18 @@
+# Contributing
+
+Source hosted at [GitHub](http://github.com/splitrb/split-api).
+Report Issues/Feature requests on [GitHub Issues](http://github.com/splitrb/split-api/issues).
+
+Tests can be ran with `rake spec`
+
+Please conform to the [Code of Conduct](CODE_OF_CONDUCT.md).
+
+## Note on Patches/Pull Requests
+
+ * Fork the project.
+ * Make your feature addition or bug fix.
+ * Add tests for it. This is important so I don't break it in a
+   future version unintentionally.
+ * Commit, do not mess with rakefile, version, or history.
+   (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+ * Send me a pull request. Bonus points for topic branches.

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013 Andrew Nesbitt
+Copyright (c) 2013-2018 Andrew Nesbitt
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

Readme.mdown

@@ -1,12 +1,14 @@
-# Split::Api
+# Split::API
 
-An extension to [Split](http://github.com/splitrb/split) to provide a REST-based JSON api.
+An extension to [Split](http://github.com/splitrb/split) to provide a REST-based JSON API.
 
-## Requirements
+## Install
+
+### Requirements
 
 The split gem and its dependencies.
 
-## Setup
+### Setup
 
     gem install split-api
 
@@ -22,13 +24,15 @@ Javascript library for communicating with api
 
 *note to be added about sharing sessions between apps*
 
-## Development
+## Contributing
 
 Source hosted at [GitHub](http://github.com/splitrb/split-api).
 Report Issues/Feature requests on [GitHub Issues](http://github.com/splitrb/split-api/issues).
 
 Tests can be ran with `rake spec`
 
+Please conform to the [Code of Conduct](CODE_OF_CONDUCT.md).
+
 ### Note on Patches/Pull Requests
 
  * Fork the project.
@@ -39,6 +43,6 @@ Tests can be ran with `rake spec`
    (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
  * Send me a pull request. Bonus points for topic branches.
 
-## Copyright
+## License
 
-Copyright (c) 2013 Andrew Nesbitt. See LICENSE for details.
+Copyright (c) 2013-2018 Andrew Nesbitt. See [LICENSE](LICENSE) for details.

split-api.gemspec

@@ -6,6 +6,7 @@ Gem::Specification.new do |gem|
   gem.email         = ["[email protected]"]
   gem.summary       = %q{Rest API extension for Split}
   gem.homepage      = 'http://github.com/splitrb/split-api'
+  gem.bug_tracker_uri      = 'http://github.com/splitrb/split-api/issues'
   gem.license       = 'MIT'
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }