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

Readme update #115

Merged
merged 34 commits into from
Mar 31, 2023
Merged

Readme update #115

merged 34 commits into from
Mar 31, 2023

Conversation

shoom3301
Copy link
Contributor

@shoom3301 shoom3301 commented Mar 30, 2023

Updated the Readme corresponding to the dogfooding changes.
Added quick start examples.

New content

@shoom3301 shoom3301 requested a review from a team March 30, 2023 13:40
@shoom3301 shoom3301 self-assigned this Mar 30, 2023
@coveralls
Copy link
Collaborator

coveralls commented Mar 30, 2023

Coverage Status

Coverage: 70.042%. Remained the same when pulling 6f9df47 on feature/readme-update into 9746464 on main.

@shoom3301 shoom3301 changed the base branch from feature/examples to main March 31, 2023 11:56
@github-actions
Copy link

github-actions bot commented Mar 31, 2023

ESLint Summary View Full Report

Annotations are provided inline on the Files Changed tab. You can also see all annotations that were generated on the annotations page.

Type Occurrences Fixable
Errors 0 0
Warnings 0 0
Ignored 4 N/A
  • Result: ✅ success
  • Annotations: 0 total

Report generated by eslint-plus-action

@shoom3301 shoom3301 merged commit 392d5c5 into main Mar 31, 2023
Copy link
Contributor

@anxolin anxolin left a comment

Choose a reason for hiding this comment

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

I see now i only half reviewed this and left unsent comments.
anyways, most of my comments are now in #117

It looks great!

- The CoW API (`cowSdk.cowApi`)
- The CoW Subgraph (`cowSdk.cowSubgraphApi`)
- Convenient method to facilitate signing orders (i.e `cowSdk.signOrder`)
- `OrderBookApi` - provides the ability to retrieve orders and trades from the CowSap order-book, as well as add and cancel them
Copy link
Contributor

Choose a reason for hiding this comment

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

nit: i think order-book doesn't have highphen

Copy link
Contributor

Choose a reason for hiding this comment

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

Also you can post signed orders :)

@alfetopito alfetopito deleted the feature/readme-update branch April 3, 2023 09:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants