Skip to content

Commit

Permalink
clean up README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
moodysalem committed Jun 10, 2020
1 parent 1d2fdda commit b1db9d0
Show file tree
Hide file tree
Showing 2 changed files with 9,838 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,28 @@
# TSDX Bootstrap
# @uniswap/token-lists

This project was bootstrapped with [TSDX](https://github.com/jaredpalmer/tsdx).
This package includes a JSON schema for token lists, and TypeScript for
validating token lists against the schema.

## Local Development

Below is a list of commands you will probably find useful.

### `npm start` or `yarn start`
### `npm start`

Runs the project in development/watch mode. Your project will be rebuilt upon changes. TSDX has a special logger for you convenience. Error messages are pretty printed and formatted for compatibility VS Code's Problems tab.

<img src="https://user-images.githubusercontent.com/4060187/52168303-574d3a00-26f6-11e9-9f3b-71dbec9ebfcb.gif" width="600" />

Your library will be rebuilt if you make edits.

### `npm run build` or `yarn build`
### `npm run build`

Bundles the package to the `dist` folder.
The package is optimized and bundled with Rollup into multiple formats (CommonJS, UMD, and ES Module).

<img src="https://user-images.githubusercontent.com/4060187/52168322-a98e5b00-26f6-11e9-8cf6-222d716b75ef.gif" width="600" />

### `npm test` or `yarn test`
### `npm test`

Runs the test watcher (Jest) in an interactive mode.
By default, runs tests related to files changed since the last commit.
Loading

0 comments on commit b1db9d0

Please sign in to comment.