README.md in active_shipping-1.0.0.pre1 vs README.md in active_shipping-1.0.0.pre2
- old
+ new
@@ -1,12 +1,11 @@
-# Active Shipping
+# ActiveShipping [](https://travis-ci.org/Shopify/active_shipping)
-[](https://travis-ci.org/Shopify/active_shipping)
-
This library interfaces with the web services of various shipping carriers. The goal is to abstract the features that are most frequently used into a pleasant and consistent Ruby API.
- Finding shipping rates
+- Registering shipments
- Tracking shipments
Active Shipping is currently being used and improved in a production environment for [Shopify][]. Development is being done by the Shopify integrations team (<integrations-team@shopify.com>). Discussion is welcome in the [Active Merchant Google Group][discuss].
[Shopify]:http://www.shopify.com
@@ -98,11 +97,11 @@
## Running the tests
After installing dependencies with `bundle install`, you can run the unit tests with `rake test:units` and the remote tests with `rake test:remote`. The unit tests mock out requests and responses so that everything runs locally, while the remote tests actually hit the carrier servers. For the remote tests, you'll need valid test credentials for any carriers' tests you want to run. The credentials should go in ~/.active_shipping/credentials.yml, and the format of that file can be seen in the included [credentials.yml](https://github.com/Shopify/active_shipping/blob/master/test/credentials.yml).
-## Contributing
+## Development
Yes, please! Take a look at the tests and the implementation of the Carrier class to see how the basics work. At some point soon there will be a carrier template generator along the lines of the gateway generator included in Active Merchant, but carrier.rb outlines most of what's necessary. The other main classes that would be good to familiarize yourself with are Location, Package, and Response.
For the features you add, you should have both unit tests and remote tests. It's probably best to start with the remote tests, and then log those requests and responses and use them as the mocks for the unit tests. You can see how this works with the USPS tests right now:
@@ -114,10 +113,10 @@
ActiveShipping::USPS.logger = Logger.new($stdout)
(This logging functionality is provided by the [`PostsData` module](https://github.com/Shopify/active_utils/blob/master/lib/active_utils/posts_data.rb) in the `active_utils` dependency.)
-After you've pushed your well-tested changes to your github fork, make a pull request and we'll take it from there!
+After you've pushed your well-tested changes to your github fork, make a pull request and we'll take it from there! For more information, see CONTRIBUTING.md.
## Legal Mumbo Jumbo
Unless otherwise noted in specific files, all code in the ActiveShipping project is under the copyright and license described in the included MIT-LICENSE file.