Permalink
Browse files

Move "Contributing" section into dedicated document for better GitHub…

  • Loading branch information...
1 parent 9619f80 commit 263a35bfcc7c877321ce0ccd1f85e3ba1cace022 @sferik sferik committed Oct 7, 2012
Showing with 34 additions and 34 deletions.
  1. +33 −0 CONTRIBUTING.md
  2. +1 −34 README.md
View
33 CONTRIBUTING.md
@@ -0,0 +1,33 @@
+## Contributing
+
+You can run the test suite against a live server by running `script/test`. It
+automatically starts a test server in background. Only tests in
+`test/adapters/*_test.rb` require a server, though.
+
+``` sh
+# run the whole suite
+$ script/test
+
+# run only specific files
+$ script/test excon typhoeus
+```
+
+We will accept middleware that:
+
+1. is useful to a broader audience, but can be implemented relatively
+ simple; and
+2. which isn't already present in [faraday_middleware][] project.
+
+We will accept adapters that:
+
+1. support SSL & streaming;
+1. are proven and may have better performance than existing ones; or
+2. if they have features not present in included adapters.
+
+We are pushing towards a 1.0 release, when we will have to follow [Semantic
+Versioning][semver]. If your patch includes changes to break compatiblitity,
+note that so we can add it to the [Changelog][].
+
+[semver]: http://semver.org/
+[changelog]: https://github.com/technoweenie/faraday/wiki/Changelog
+[faraday_middleware]: https://github.com/pengwynn/faraday_middleware/wiki
View
35 README.md
@@ -175,36 +175,6 @@ stubs.verify_stubbed_calls
* support streaming requests/responses
* better stubbing API
-## Contributing
-
-You can run the test suite against a live server by running `script/test`. It
-automatically starts a test server in background. Only tests in
-`test/adapters/*_test.rb` require a server, though.
-
-``` sh
-# run the whole suite
-$ script/test
-
-# run only specific files
-$ script/test excon typhoeus
-```
-
-We will accept middleware that:
-
-1. is useful to a broader audience, but can be implemented relatively
- simple; and
-2. which isn't already present in [faraday_middleware][] project.
-
-We will accept adapters that:
-
-1. support SSL & streaming;
-1. are proven and may have better performance than existing ones; or
-2. if they have features not present in included adapters.
-
-We are pushing towards a 1.0 release, when we will have to follow [Semantic
-Versioning][semver]. If your patch includes changes to break compatiblitity,
-note that so we can add it to the [Changelog][].
-
## Supported Ruby versions
This library aims to support and is [tested against][travis] the following Ruby
@@ -240,11 +210,8 @@ See [LICENSE][] for details.
[travis]: http://travis-ci.org/technoweenie/faraday
[jruby]: http://jruby.org/
[rubinius]: http://rubini.us/
- [semver]: http://semver.org/
- [changelog]: https://github.com/technoweenie/faraday/wiki/Changelog
[excon]: https://github.com/geemus/excon#readme
[typhoeus]: https://github.com/typhoeus/typhoeus#readme
[patron]: http://toland.github.com/patron/
- [eventmachine]: https://github.com/igrigorik/em-http-request#readme
- [faraday_middleware]: https://github.com/pengwynn/faraday_middleware/wiki
+ [eventmachine]: https://github.com/igrigorik/em-http-request#readme

0 comments on commit 263a35b

Please sign in to comment.