diff --git a/README.md b/README.md new file mode 100644 index 000000000..e41b45342 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Pancake Toolkit + +This repository is a monorepo manage with [yarn workspaces](https://classic.yarnpkg.com/en/docs/workspaces/) and [Lerna](https://lerna.js.org/). + +## Packages + +- [pancake-uikit](https://github.com/pancakeswap/pancake-toolkit/tree/master/packages/pancake-uikit) : React components used to build the Pancake UI +- [eslint-config-pancake](https://github.com/pancakeswap/pancake-toolkit/tree/master/packages/eslint-config-pancake) : An ESLint config for pancake, with Typescript and Prettier support + +## How to use + +Clone the repository + +``` +git clone git@github.com:pancakeswap/pancake-toolkit.git +``` + +Run yarn at the root of the workspace + +``` +cd pancake-toolkit +yarn +``` + +Then, refer to the readme of each project. \ No newline at end of file