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

[PSDK-119] Initial README #14

Merged
merged 3 commits into from
May 17, 2024
Merged

Conversation

John-peterson-coinbase
Copy link
Contributor

What changed? Why?

  • Adds initial README documentation

Qualified Impact

erdimaden
erdimaden previously approved these changes May 16, 2024
@cb-heimdall cb-heimdall dismissed erdimaden’s stale review May 17, 2024 07:17

Approved review 2061877296 from erdimaden is now dismissed due to new commit. Re-request for approval.

After running `npx ts-node` to start the REPL, you can import the SDK as follows:

```typescript
import { Coinbase } from '@coinbase/coinbase-sdk';
Copy link
Contributor

Choose a reason for hiding this comment

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

Wouldn't they also need to do npm install?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

The assumption made was that the developer would do npm install above in their project and run the Repl from there. If that is unclear, I can update! @yuga-cb

```bash
npm install @coinbase/coinbase-sdk
```

Copy link
Contributor

Choose a reason for hiding this comment

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

add yarn option?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

added in most recent commit!

@John-peterson-coinbase John-peterson-coinbase merged commit 966c368 into master May 17, 2024
6 checks passed
@erdimaden erdimaden deleted the psdk-119-readme-init branch June 21, 2024 18:04
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.

3 participants