Skip to content

Update Readme [Future]#81

Merged
brianmc merged 8 commits intoAuthorizeNet:Futurefrom
Vyoam:Future
Nov 3, 2015
Merged

Update Readme [Future]#81
brianmc merged 8 commits intoAuthorizeNet:Futurefrom
Vyoam:Future

Conversation

@Vyoam
Copy link
Copy Markdown
Contributor

@Vyoam Vyoam commented Oct 26, 2015

(Note that this is in the Future branch)
Please review the updated README.

READMEs in SDKs of other languages would be updated in the same format once this is approved.

Thanks,
Akash Amat (aamat, visa)

Vyoam added 2 commits October 26, 2015 11:51
Updated README for consistency with the new model of the sdk.
@Vyoam Vyoam changed the title Future Update Readme [Future] Oct 26, 2015
Comment thread README.md Outdated
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we need to refer to old model in the updated readme. We should keep the old usage examples but just put a readme in the top of the old model folders and clearly say this is deprecated funtionality.

@brianmc
Copy link
Copy Markdown
Contributor

brianmc commented Oct 28, 2015

Thank-you for the updates, they look great just a couple of small comments.

Vyoam added 3 commits October 29, 2015 13:51
Removed references to the old model SDK.
Also removed Apple Pay sample, as advised by @ramittal ('reference the sample-code so that it is always up-do date and verified functional'). But, I thought one sample ('Quick Usage Example' here) should be kept to illustrate the setup.
Removed details other than the sample code and its dependencies.
Correct formatting.
@Vyoam
Copy link
Copy Markdown
Contributor Author

Vyoam commented Oct 29, 2015

Hi @brianmc

I've done the changes you advised:

  1. remove references to old model from /README.md
  2. trim /README_OLD.md and move-rename to /lib/DeprecatedSamples.md

Please give this a look. Also please confirm if (/lib/) is the right place to keep the old samples.
This folder does contain all the old model classes.

Thanks,
Akash Amat (aamat, visa)

Trimmed usage example section to only keep the links to the dev center sample codes.
@brianmc
Copy link
Copy Markdown
Contributor

brianmc commented Oct 30, 2015

Thanks Akash, I would still like to see a very simple example in the usage section (e.g. the very simplest charge credit card with only the required fields) but also reference the samples repo.

Thanks,

Brian

Vyoam added 2 commits November 3, 2015 15:49
Added a quick usage example (charge credit card).
Section for logging details added.
Necessary information about logging like defining regexes in configuration, file paths, and logging and masking usage is mentioned.
brianmc added a commit that referenced this pull request Nov 3, 2015
Update Readme [Future]
@brianmc brianmc merged commit 03f9b3a into AuthorizeNet:Future Nov 3, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants