Skip to content

Commit

Permalink
chore: updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
foxhound87 committed Apr 28, 2023
1 parent 5d26af9 commit 290d1ed
Show file tree
Hide file tree
Showing 4 changed files with 247 additions and 22 deletions.
1 change: 1 addition & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
{
"parser": "@typescript-eslint/parser",
"plugins": ["import"],
"rules": {
"import/no-unresolved": "off",
"import/extensions": "off",
Expand Down
27 changes: 12 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,23 @@

##### DevTools for [MobX React Form](https://github.com/foxhound87/mobx-react-form)

[![Travis Build](https://img.shields.io/travis/foxhound87/mobx-react-form-devtools/master.svg)](https://travis-ci.org/foxhound87/mobx-react-form-devtools)
---

[![NPM](https://nodei.co/npm/mobx-react-form-devtools.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/mobx-react-form-devtools/)

![GitHub Workflow Status (with branch)](https://img.shields.io/github/actions/workflow/status/foxhound87/mobx-react-form-devtools/ci.yml?branch=next)
![GitHub release (latest by date)](https://img.shields.io/github/v/release/foxhound87/mobx-react-form-devtools)
![npm bundle size](https://img.shields.io/bundlephobia/min/mobx-react-form-devtools)
[![Codecov Coverage](https://img.shields.io/codecov/c/github/foxhound87/mobx-react-form-devtools/master.svg)](https://codecov.io/gh/foxhound87/mobx-react-form-devtools)
[![Downloads](https://img.shields.io/npm/dt/mobx-react-form-devtools.svg)]()
[![npm](https://img.shields.io/npm/v/mobx-react-form-devtools.svg)]()
[![node](https://img.shields.io/node/v/mobx-react-form-devtools.svg)]()
[![GitHub license](https://img.shields.io/github/license/foxhound87/mobx-react-form-devtools.svg)]()

[![NPM](https://nodei.co/npm/mobx-react-form-devtools.png?downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/mobx-react-form-devtools/)
![GitHub closed pull requests](https://img.shields.io/github/issues-pr-closed/foxhound87/mobx-react-form-devtools)
![GitHub closed issues](https://img.shields.io/github/issues-closed-raw/foxhound87/mobx-react-form-devtools)
[![Downloads](https://img.shields.io/npm/dt/mobx-react-form-devtools.svg)]()
[![Downloads](https://img.shields.io/npm/dm/mobx-react-form-devtools.svg)]()

---

<br>

## Install

```bash
Expand All @@ -23,7 +27,7 @@ npm install --save mobx-react-form-devtools

## Demo

[MobX React Form DevTools Demo](https://foxhound87.github.io/mobx-react-form/demo.html)
[MobX React Form DevTools Demo](https://foxhound87.github.io/mobx-react-form-demo)

## Usage

Expand Down Expand Up @@ -75,13 +79,6 @@ MobxReactFormDevTools.theme({

![DevTools](https://github.com/foxhound87/mobx-react-form-devtools/blob/master/screenshot.png?raw=true)

## Link DevTools to Demo

```bash
❯ git clone -b master [email protected]:foxhound87/mobx-react-form-devtools.git mobx-react-form-devtools--master
❯ ln -s ../mobx-react-form-devtools--master ./mobx-react-form--demo/devtools
```

## Contributing

If you want to contribute to the development, do not hesitate to fork the repo and send pull requests.
Expand Down
240 changes: 233 additions & 7 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,7 @@
"css-loader": "^6.7.3",
"cz-conventional-changelog": "^1.2.0",
"eslint": "^8.35.0",
"eslint-plugin-import": "^2.27.5",
"husky": "^0.12.0",
"mocha": "^10.2.0",
"npm-run-all": "^3.1.2",
Expand Down

0 comments on commit 290d1ed

Please sign in to comment.