Skip to content

Commit 19745e6

Browse files
committed
standardize readme format and info across repos
1 parent ab9f1c1 commit 19745e6

1 file changed

Lines changed: 13 additions & 11 deletions

File tree

README.md

Lines changed: 13 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,13 +41,9 @@ echo "Connection uses " . $json->tls_version ."\n";
4141

4242
## Installation
4343

44-
### Autoloading
45-
We recommend using [`Composer`](http://getcomposer.org) *(note we never recommend you
46-
override the new secure-http default setting)*. Don't forget to require its autoloader
47-
in your script or bootstrap file:
48-
```php
49-
require 'vendor/autoload.php';
50-
```
44+
### Composer
45+
We recommend using [`Composer`](http://getcomposer.org). *(Note: we never recommend you
46+
override the new secure-http default setting)*.
5147
*Update your composer.json file as per the example below and then run
5248
`composer update`.*
5349

@@ -60,6 +56,13 @@ require 'vendor/autoload.php';
6056
}
6157
```
6258

59+
After installation through Composer,
60+
don't forget to require its autoloader in your script or bootstrap file:
61+
```php
62+
require 'vendor/autoload.php';
63+
```
64+
65+
### Custom SPL Autoloader
6366
Alternatively, we provide a custom `SPL` autoloader for you to reference from within your PHP file:
6467
```php
6568
require 'path/to/anet_php_sdk/autoload.php';
@@ -82,7 +85,6 @@ To authenticate with the Authorize.Net API you will need to use your account's A
8285
Once you have your keys simply load them into the appropriate variables in your code, as per the below sample code dealing with the authentication part of the API request.
8386

8487
#### To set your API credentials for an API request:
85-
8688
...
8789
```php
8890
use net\authorize\api\contract\v1 as AnetAPI;
@@ -203,15 +205,15 @@ Add PhpDocumentor to your composer.json and run `composer update --dev`:
203205
"phpdocumentor/phpdocumentor": "*"
204206
}
205207
```
206-
To autogenerate PHPDocs run:
208+
To autogenerate PHPDocs run the following at the command line (from the same directory as your composer.json):
207209
```shell
208-
vendor/bin/phpdoc -t doc/api/ -d lib
210+
vendor/bin/phpdoc -t vendor/authorizenet/authorizenet/doc/api/ -d vendor/authorizenet/authorizenet/lib
209211
```
210212

211213

212214
## License
213215

214-
This repository is destributed under a proprietary license. See the provided [`LICENSE.txt`](/license.txt) file.
216+
This repository is distributed under a proprietary license. See the provided [`LICENSE.txt`](/license.txt) file.
215217

216218

217219

0 commit comments

Comments
 (0)