README.md in berkshelf-api-0.2.0 vs README.md in berkshelf-api-1.0.0

- old
+ new

@@ -1,9 +1,10 @@ # Berkshelf::API [![Gem Version](https://badge.fury.io/rb/berkshelf-api.png)](http://badge.fury.io/rb/berkshelf-api) [![Build Status](https://secure.travis-ci.org/RiotGames/berkshelf-api.png?branch=master)](http://travis-ci.org/RiotGames/berkshelf-api) [![Dependency Status](https://gemnasium.com/RiotGames/berkshelf-api.png?travis)](https://gemnasium.com/RiotGames/berkshelf-api) +[![Code Climate](https://codeclimate.com/github/RiotGames/berkshelf-api.png)](https://codeclimate.com/github/RiotGames/berkshelf-api) A server which indexes cookbooks from various sources and hosts it over a REST API ## Installation @@ -21,38 +22,42 @@ Ruby 1.9.1 and 1.9.2 are not officially supported. If you encounter problems, please upgrade to Ruby 2.0 or 1.9.3. ## Configuring Endpoints -Which endpoints to index can be configured by editing the JSON configuration file (by default at: `~/.berkshelf/api-server/config.json`). +You may configure the endpoints to index by editing the JSON configuration file (default: `~/.berkshelf/api-server/config.json`). ### Opscode Community Site - { - "endpoints": [ - { - type: "opscode", - options: { - url: 'http://cookbooks.opscode.com/api/v1' - } +````json +{ + "endpoints": [ + { + "type": "opscode", + "options": { + "url": "http://cookbooks.opscode.com/api/v1" } - ] - } + } + ] +} +``` ### Chef Server - { - "endpoints": [ - { - "type": "chef_server", - "options": { - "url": "https://api.opscode.com/organizations/vialstudios", - "client_name": "berkshelf", - "client_key": "/etc/berkshelf/api-server/client.pem" - } +```json +{ + "endpoints": [ + { + "type": "chef_server", + "options": { + "url": "https://api.opscode.com/organizations/vialstudios", + "client_name": "berkshelf", + "client_key": "/etc/berkshelf/api-server/client.pem" } - ] - } + } + ] +} +``` ## Contributing 1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)