Skip to content

Commit

Permalink
docs: Add a readme at the workspace root
Browse files Browse the repository at this point in the history
  • Loading branch information
RabbitDoge committed Mar 17, 2021
1 parent 0e0454e commit 9612928
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.

0 comments on commit 9612928

Please sign in to comment.