diff --git a/README.md b/README.md index c12ca50..fcc7d1d 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,20 @@ An implementation of a UI for the Serum DEX. +### Running the UI + +Run `yarn` to install dependencies, then run `yarn start` to start a development server or `yarn build` to create a production build that can be served by a static file server. + +### Collect referral fees + +Set the `REACT_APP_USDT_REFERRAL_FEES_ADDRESS` and `REACT_APP_USDC_REFERRAL_FEES_ADDRESS` environment variables to the addresses of your USDT and USDC SPL token accounts. + +You may want to put these in local environment files (e.g. `.env.development.local`, `.env.production.local`). See the [documentation](https://create-react-app.dev/docs/adding-custom-environment-variables) on environment variables for more information. + +See the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started) for other commands and options. + +--- + See [A technical introduction to the Serum DEX](https://projectserum.com/blog/serum-dex-introduction) to learn more about the Serum DEX. See [serum-js](https://github.com/project-serum/serum-js) for DEX client-side code. Serum DEX UI uses this library. @@ -9,9 +23,3 @@ See [serum-js](https://github.com/project-serum/serum-js) for DEX client-side co See [sol-wallet-adapter](https://github.com/project-serum/sol-wallet-adapter) for an explanation of how the Serum DEX UI interacts with wallet services to sign and send requests to the Serum DEX. See [spl-token-wallet](https://github.com/project-serum/spl-token-wallet) for an implementation of such a wallet, live at [sollet.io](https://sollet.io). - ---- - -Run `yarn` to install dependencies, then run `yarn start` to start a development server or `yarn build` to create a production build that can be served by a static file server. - -See the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started) for other commands and options.