Skip to content

Commit 62a84f5

Browse files
authored
Merge pull request #126 from pedelman/readme_improvements
Improvements to the README
2 parents c2eaf31 + 1a81dec commit 62a84f5

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

README.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,15 @@ gem 'bigcommerce', '~> 1.0.0'
2424
- Ruby 2.0.0 or newer. Please refer to the `.travis.yml` to see which versions we officially support.
2525

2626
## Getting Started
27-
In order to make requests to our API, you must register as a developer and have your credentials ready.
27+
To make requests to our API, you must register as a developer and have your credentials ready.
2828

29-
Its also very important to note that for the OAuth authentication mechanism, the resources you have acccess to depend on the scopes which your application has been granted by the merchant. For more information about the Store API scopes, see: [OAuth Scopes](https://developer.bigcommerce.com/api/scopes).
29+
Also very important: For the OAuth authentication mechanism, the resources to which you have acccess depend on the scopes that the merchant has granted to your application. For more information about Store API scopes, see: [OAuth Scopes](https://developer.bigcommerce.com/api/scopes).
3030

3131
## Authentication
32-
We currently have two different authentication schemes you can use depending on your use case.
32+
We currently have two different authentication schemes that you can select, depending on your use case.
3333

3434
### OAuth
35-
OAuth apps can be submitted to [BigCommerce App Store](https://www.bigcommerce.com/apps), allowing other merchants to install it in their BigCommerce store.
35+
OAuth apps can be submitted to [BigCommerce App Store](https://www.bigcommerce.com/apps), allowing other merchants to install these apps in their BigCommerce stores.
3636

3737
__[More Information](https://developer.bigcommerce.com/api/using-oauth-intro)__
3838

@@ -42,11 +42,11 @@ To develop a custom integration for one store, your app needs to use Basic Authe
4242
__[More Information](https://developer.bigcommerce.com/api/legacy/basic-auth)__
4343

4444
## Configuration
45-
In order to authenticate the API client, you will need to configure the client like the following.
45+
To authenticate your API client, you will need to configure the client like the following examples.
4646

4747
### OAuth App
4848

49-
- ```client_id```: Obtained from the "My Apps" section on the [developer portal](http://developer.bigcommerce.com).
49+
- ```client_id```: Obtained from the on the BigCommerce [Developer Portal's](http://developer.bigcommerce.com) "My Apps" section.
5050
- ```access_token```: Obtained after a token exchange in the auth callback.
5151
- ```store_hash```: Also obtained after the token exchange.
5252

@@ -60,7 +60,7 @@ end
6060

6161
### Basic Authentication (Legacy)
6262

63-
To get all the basic auth credentials, simply visit your store admin page and navigate to the `Advanced Settings > Legacy API Settings`. Once there, you can create a new legacy api account to authenticate with.
63+
To get all the basic auth credentials, simply visit your store admin page, and navigate to the `Advanced Settings` > `Legacy API Settings`. Once there, you can create a new legacy API account on which to authenticate.
6464

6565
```rb
6666
Bigcommerce.configure do |config|
@@ -73,7 +73,7 @@ end
7373

7474
__SSL Configuration__
7575

76-
If you are using your own self-signed certificate, you can pass SSL options to Faraday. This is not required, but may be useful in special edge cases.
76+
If you are using your own, self-signed, certificate, you can pass SSL options to Faraday. This is not required, but might be useful in special edge cases.
7777

7878
```rb
7979
Bigcommerce.configure do |config|
@@ -90,11 +90,11 @@ end
9090
For more information about configuring SSL with Faraday, please see the following:
9191

9292
- [Faraday SSL example](https://gist.github.com/mislav/938183)
93-
- [Setting up SSL certificates](https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates)
93+
- [Faraday: Setting up SSL certificates](https://github.com/lostisland/faraday/wiki/Setting-up-SSL-certificates)
9494

9595

9696
## Usage
97-
For full examples on using the API client, please see the [examples folder](examples) and refer to the [developer documentation](https://developer.bigcommerce.com/api).
97+
For full examples of using the API client, please see the [examples folder](examples) and refer to BigCommerce's [developer documentation](https://developer.bigcommerce.com/api).
9898

9999
Example:
100100

@@ -113,11 +113,11 @@ Bigcommerce::System.time
113113

114114
### Thread Safety
115115

116-
The `Bigcommerce.configure` method is NOT thread safe. This mechanism is designed for applications or cli where thread safety is not a concern. If you need to guarantee thread safety, we support another mechanism to make threadsafe API requests.
116+
The `Bigcommerce.configure` method is NOT thread-safe. This mechanism is designed for applications or CLI's (command-line interfaces) where thread safety is not a concern. If you need to guarantee thread safety, we support this alternative mechanism to make thread-safe API requests:
117117

118-
Rather then setting up a single `connection` for all API requests, you will want to construct a new connection for each thread. If you can make sure that each of these connections is stored in a thread safe manner, you can pass the `connection` as you query the resource.
118+
Rather then setting up a single `connection` for all API requests, you would construct a new connection for each thread. If you can ensure that each of these connections is stored in a thread-safe manner, you can pass the `connection` as you query the resource.
119119

120-
This connection is nothing more than a `Faraday::Connection` so if you want to write your own, or use your own adapers, you can feel free. Please refer to the [connection class](https://github.com/bigcommerce/bigcommerce-api-ruby/blob/master/lib/bigcommerce/connection.rb) for more details.
120+
This connection is nothing more than a `Faraday::Connection` so if you want to write your own, or to use your own adapters, you can feel free. Please refer to this gem's [connection class](https://github.com/bigcommerce/bigcommerce-api-ruby/blob/master/lib/bigcommerce/connection.rb) for more details.
121121

122122
##### OAuth
123123

@@ -159,4 +159,4 @@ Bigcommerce::System.raw_request(:get, 'time', connection: connection_legacy)
159159
```
160160

161161
## Contributing
162-
See [CONTRIBUTING.md](CONTRIBUTING.md)
162+
See [CONTRIBUTING.md](CONTRIBUTING.md)

0 commit comments

Comments
 (0)