Skip to content

Commit f7b25d7

Browse files
authored
cleanup readme
1 parent 00741cc commit f7b25d7

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ Apart from this README, you can find details and examples of using the SDK in th
7777
### Quick Usage Example (with Charge Credit Card - Authorize and Capture)
7878
Note: The following is a php console application. Ensure that you can invoke the php command from command line.
7979
- Save the below code to a php file named, say, `charge-credit-card.php`
80-
- Open command prompt and navigate to your sdk folder ( if want to run from a different folder, modify the `require` statement to have the full path to the sdk e.g. `require 'c:/anet-sdk-php/vendor/autoload.php'` in place of `require 'vendor/autoload.php'` )
80+
- Open command prompt and navigate to your SDK folder ( if want to run from a different folder, modify the `require` statement to have the full path to the SDK e.g. `require 'c:/anet-sdk-php/vendor/autoload.php'` in place of `require 'vendor/autoload.php'` )
8181
- Update dependecies - e.g., With composer, type `composer update`
8282
- Type `php [<path to folder containing the php file>\]charge-credit-card.php`
8383

@@ -138,7 +138,7 @@ $response = $controller->executeWithApiResponse( \net\authorize\api\constants\AN
138138

139139
## Logging
140140

141-
SDK generates log with masking for sensitive data like credit card, expiration dates. The provided levels for logging are
141+
The SDK generates a log with masking for sensitive data like credit card, expiration dates. The provided levels for logging are
142142
`debug`, `info`, `warn`, `error`. Add ````use \net\authorize\util\LogFactory;````. Logger can be initialized using `$logger = LogFactory::getLog(get_class($this));`
143143
The default log file `phplog` gets generated in the current folder. The subsequent logs are appended to the same file, unless the execution folder is changed, and a new log file is generated.
144144

@@ -148,7 +148,7 @@ The default log file `phplog` gets generated in the current folder. The subseque
148148
- Logging using formatting `$logger->debugFormat("Integer: %d, Float: %f, Xml-Request: %s\n", array(100, 1.29f, $xmlRequest));`
149149

150150
### Customizing Sensitive Tags
151-
A local copy of [AuthorizedNetSensitiveTagsConfig.json](/lib/net/authorize/util/ANetSensitiveFields.php) gets generated when code invoking the logger first gets executed. The local file can later be edited by developer to re-configure what is masked and what is visible. (*Do not edit the json in sdk*).
151+
A local copy of [AuthorizedNetSensitiveTagsConfig.json](/lib/net/authorize/util/ANetSensitiveFields.php) gets generated when code invoking the logger first gets executed. The local file can later be edited by developer to re-configure what is masked and what is visible. (*Do not edit the JSON in the SDK*).
152152
- For each element of the `sensitiveTags` array,
153153
- `tagName` field corresponds to the name of the property in object, or xml-tag that should be hidden entirely ( *XXXX* shown if no replacement specified ) or masked (e.g. showing the last 4 digits of credit card number).
154154
- `pattern`[<sup>[Note]</sup>](#regex-note) and `replacement`[<sup>[Note]</sup>](#regex-note) can be left `""`, if the default is to be used (as defined in [Log.php](/lib/net/authorize/util/Log.php)). `pattern` gives the regex to identify, while `replacement` defines the visible part.

0 commit comments

Comments
 (0)