From d8941870a157779d7936e482ed4c1f25d206a908 Mon Sep 17 00:00:00 2001 From: Diogo Ferreira Date: Mon, 6 Nov 2023 22:42:54 +0000 Subject: [PATCH] update Readme with getting started --- README.md | 31 +++++++++++++++++++++++++------ 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index a1c01586..c5b27595 100644 --- a/README.md +++ b/README.md @@ -2,10 +2,6 @@ ## Getting Started -### Running tests - -To run the tests, follow these steps. You must have at least node v16 installed. - First clone the repository: ```sh @@ -21,13 +17,36 @@ cd swapr-sdk Install dependencies ```sh -npm install +yarn install +``` + + Generate GraphQL +```sh +yarn codegen +``` + +Build +```sh +yarn build ``` +Connect package an app to sdk locally +```sh +yarn link +``` +And on the app repo +```sh +yarn link "../swapr-sdk/" #e.g. path to sdk +``` + +### Running tests + +To run the tests, follow these steps. You must have at least node v16 installed. + Run tests ```sh -npm run test +yarn test ``` ## Eco Router Trades