Skip to content

Commit

Permalink
Use latest core for widget, update readmes (#39)
Browse files Browse the repository at this point in the history
  • Loading branch information
NotJeremyLiu authored Jul 8, 2024
1 parent 81ca1ea commit e93fd70
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 11 deletions.
6 changes: 6 additions & 0 deletions .changeset/happy-ligers-attend.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
'@skip-go/widget': minor
'@skip-go/core': minor
---

Update readmes and have widget use latest core
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# skip-go
# Skip Go

## Project Structure

Expand Down
13 changes: 6 additions & 7 deletions packages/core/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

# @skip-go/core

JavaScript SDK for Skip API
JavaScript SDK for Skip Go API

## Install

Expand All @@ -16,14 +16,14 @@ npm install @skip-go/core

## Usage

Read more at Skip API docs website on [Getting Started: TypeScript SDK](https://api-docs.skip.money/docs/getting-started).
Read more at Skip Go API docs website on [Getting Started: TypeScript SDK](https://docs.skip.build/go/general/getting-started).

## Development

```bash
# clone repository
git clone https://github.com/skip-mev/skip-router-sdk.git
cd skip-router-sdk
git clone https://github.com/skip-mev/skip-go.git
cd skip-go/packages/core

# prepare submodules
git submodule update --init --recursive
Expand Down Expand Up @@ -71,6 +71,5 @@ npm run e2e:stop

## Documentation

- [Skip API documentation](https://api-docs.skip.money)
- [Skip API Reference](https://api-docs.skip.money/reference)
- [Skip API Reference (Swagger)](https://api-swagger.skip.money)
- [Skip Go API documentation](https://docs.skip.build/go)
- [Skip Go API Reference](https://docs.skip.build/go/api-reference/prod/info/get-v2infochains)
2 changes: 1 addition & 1 deletion packages/core/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@skip-go/core",
"description": "JavaScript SDK for Skip API",
"description": "JavaScript SDK for Skip Go API",
"version": "0.3.0",
"repository": "https://github.com/skip-mev/skip-router-sdk",
"main": "dist/index.js",
Expand Down
4 changes: 2 additions & 2 deletions packages/widget/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Skip Go Widget

The `@skip-go/widget` package is an npm package providing a React component for a full swap interface using the [Skip API](https://skip.build/).
The `@skip-go/widget` package is an npm package providing a React component for a full swap interface using the [Skip Go API](https://skip.build/).

## Installation

Expand Down Expand Up @@ -110,7 +110,7 @@ The `SwapWidgetProvider` component accepts the following prop:
};
```

- `apiURL` (Optional): Custom API URL to override Skip API endpoint. Defaults to Skip proxied endpoints. Please reach out to us first if you want to be whitelisted.
- `apiURL` (Optional): Custom API URL to override Skip Go API endpoint. Defaults to Skip proxied endpoints. Please reach out to us first if you want to be whitelisted.

By following these steps, you can easily integrate the Skip Go Widget into your React application and customize it to meet your specific needs.

Expand Down

0 comments on commit e93fd70

Please sign in to comment.