Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation #15

Merged
merged 7 commits into from
Jan 4, 2019
Merged

Update documentation #15

merged 7 commits into from
Jan 4, 2019

Conversation

nmarley
Copy link

@nmarley nmarley commented Dec 29, 2018

  • Update package author
  • Cleanup README a bit and add publish instructions to README
  • Dashify documentation and remove bower references

Based on #13, so that should be merged first.

Please use "Squash and Merge option" when merging.

Copy link

@Cofresi Cofresi left a comment

Choose a reason for hiding this comment

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

use the @dashevo namespace npm packages

README.md Outdated

## Getting Started

This library is distributed in both the npm and bower packaging systems.

```sh
npm install dashcore-lib
npm install dashcore-payment-protocol
Copy link

@Cofresi Cofresi Jan 3, 2019

Choose a reason for hiding this comment

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

npm install @dashevo/dashcore-lib
npm install @dashevo/dashcore-payment-protocol

Copy link
Author

Choose a reason for hiding this comment

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

Nice catch! Should be fixed in both files now.

Copy link

@Cofresi Cofresi left a comment

Choose a reason for hiding this comment

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

same as above

bower install bitcore-lib --save
bower install bitcore-payment-protocol --save
npm install dashcore-lib
npm install dashcore-payment-protocol
```
Copy link

@Cofresi Cofresi Jan 3, 2019

Choose a reason for hiding this comment

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

npm install @dashevo/dashcore-lib
npm install @dashevo/dashcore-payment-protocol

Here the merchant's server will construct the payment details message:

```javascript
var PaymentProtocol = require('bitcore-payment-protocol');
var PaymentProtocol = require('dashcore-payment-protocol');
var now = Date.now() / 1000 | 0;

Copy link

Choose a reason for hiding this comment

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

var PaymentProtocol = require('@dashevo/dashcore-payment-protocol');

@Cofresi Cofresi merged commit 9db06aa into develop Jan 4, 2019
@Cofresi Cofresi deleted the docs branch January 4, 2019 00:28
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