Skip to content

Commit

Permalink
chore: minor updates into the readmes
Browse files Browse the repository at this point in the history
  • Loading branch information
wainola committed Jun 12, 2024
1 parent 50a0d4d commit d8d8f05
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The Sygma Widget is a customizable frontend that leverages the `Sygma protocol` and can be integrated into any Dapp regardless of the framework used. More information can be found in our [docs](https://docs.buildwithsygma.com/)

This repository is divided into two packages. The [Widget](./packages/widget/) package is a web component built using Lit framework that allows you to have a widget for the `Sygma` protocol project`. The [React](./packages/react/) package is a wrapper around the Lit Widget that allows developers to use this application inside react projects.
This repository is divided into two packages. The [Widget](./packages/widget/) package is a web component built using Lit framework that allows you to have a widget for the `Sygma` protocol project. The [React](./packages/react/) package is a wrapper around the Lit Widget that allows developers to use this application inside react projects.

## Quick setup

Expand All @@ -16,9 +16,9 @@ yarn dev

## How to integrate

Check respective readmes to follow instructions on how to integrate the Widget into your codebase.
Check respective READMES to follow instructions on how to integrate the Widget into your codebase.

* for Lit based projects you can directly install, import and use the web component version of the Widget. You can find further instructions [here](./packages/widget/README.md)
* for web component based projects, you can directly install, import and use the Widget. You can find further instructions [here](./packages/widget/README.md)
* for React based projects, please refer to this [README](./packages/react/README.md) file to get further instructions
* a react example is provided [here](/examples/react-widget-app/) for a more detailed reference

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

## Quick setup

To integrate this Widget into any react project follow this instructions below
To integrate this Widget into any React project follow this instructions below

### Dependencies

Expand Down Expand Up @@ -40,7 +40,7 @@ You can also pass props to the Widget component to customize it:
function MyDapp(){
return (
<SygmaProtocolReactWidget
environment={Environment.MAINNET}
environment={'mainnet'}
whitelistedSourceNetworks={["sepolia"]}
whitelistedDestinationNetworks={["cronos"]}
evmProvider={myEip1193Provider}
Expand Down
6 changes: 3 additions & 3 deletions packages/widget/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,15 @@

### Dependencies

To integrate the Widget to any lit project that you have, you will need to add the following dependencies:
To integrate the Widget into any project that uses web components you will need to add the following dependencies:

```bash
yarn add @buildwithsygma/sygmaprotocol-widget @buildwithsygma/sygma-sdk-core
```

### Code integration

To add the Wdiget to your existing codebase just import the dependency and add the custom tag into your render method.
To add the Wdiget to your existing codebase import the dependency and add the custom tag into your render method.

```ts
import { LitElement, html } from 'lit'
Expand Down Expand Up @@ -43,7 +43,7 @@ render() {
return html`
<div>
<sygmaprotocol-widget
.environment=${Environment.MAINNET}
.environment=${'mainnet'}
.whitelistedSourceNetworks=${['sepolia']}
.whitelistedDestinationNetworks=${['cronos']}
></sygmaprotocol-widget>
Expand Down

0 comments on commit d8d8f05

Please sign in to comment.