Skip to content

Commit

Permalink
removed documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
NishargShah committed Feb 12, 2021
1 parent 332a9fd commit d953e7d
Show file tree
Hide file tree
Showing 12 changed files with 11 additions and 431 deletions.
8 changes: 3 additions & 5 deletions .npmignore
Original file line number Diff line number Diff line change
@@ -1,11 +1,9 @@
.github
.idea
.storybook
build
public
src
storybook-static
.eslintrc
.babelrc
.eslintcache
.eslintignore
.eslintrc
.prettierrc
.babelrc
10 changes: 0 additions & 10 deletions .storybook/main.js

This file was deleted.

8 changes: 0 additions & 8 deletions .storybook/preview.js

This file was deleted.

10 changes: 3 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,12 +20,12 @@ npm install react-img-mapper --save
```
## Demo & Examples
Live demo: [demo](https://nishargshah.github.io/react-img-mapper)
Live demo: [demo](https://react-img-mapper.github.io/react-img-mapper)

To run the example locally

```
git clone https://github.com/NishargShah/react-img-mapper.git
git clone https://github.com/react-img-mapper/docs.git
npm install
npm start
```
Expand All @@ -36,11 +36,7 @@ If you want to change something and want to make a compiled file, you just need
## Usage
Import the component as you normally do, and add it wherever you like in your JSX views as below:

```javascript
// ES5 require
var ImageMapper = require('react-img-mapper');

// ES6 import
```javascript
import ImageMapper from 'react-img-mapper';

<ImageMapper src={IMAGE_URL} map={AREAS_MAP}/>
Expand Down
25 changes: 5 additions & 20 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,26 +11,22 @@
"img mapper",
"image mapper"
],
"homepage": "https://nishargshah.github.io/react-img-mapper",
"homepage": "https://react-img-mapper.github.io/react-img-mapper",
"bugs": {
"url": "https://github.com/NishargShah/react-img-mapper/issues"
"url": "https://github.com/react-img-mapper/react-img-mapper/issues"
},
"repository": {
"type": "git",
"url": "https://github.com/NishargShah/react-img-mapper.git"
"url": "https://github.com/react-img-mapper/react-img-mapper.git"
},
"license": "MIT",
"author": "Nisharg Shah",
"main": "lib/ImageMapper.js",
"scripts": {
"build": "build-storybook",
"compile": "babel src/lib/** -d lib",
"predeploy": "npm run build",
"deploy": "gh-pages -d storybook-static",
"lint": "eslint . --ext .js",
"lint-fix": "eslint . --ext .js --fix",
"prepublishOnly": "npm run compile",
"start": "start-storybook -p 3000"
"prepublishOnly": "npm run compile"
},
"browserslist": {
"production": [
Expand All @@ -52,15 +48,8 @@
"@babel/core": "^7.12.10",
"@babel/preset-env": "^7.12.11",
"@babel/preset-react": "^7.12.10",
"@storybook/addon-actions": "^6.1.15",
"@storybook/addon-essentials": "^6.1.15",
"@storybook/addon-links": "^6.1.15",
"@storybook/addon-storysource": "^6.1.15",
"@storybook/preset-scss": "^1.0.3",
"@storybook/react": "^6.1.15",
"babel-eslint": "^10.1.0",
"babel-loader": "^8.1.0",
"css-loader": "^5.0.1",
"eslint": "^7.17.0",
"eslint-config-airbnb": "^18.2.1",
"eslint-config-prettier": "^7.1.0",
Expand All @@ -71,13 +60,9 @@
"eslint-plugin-prettier": "^3.3.1",
"eslint-plugin-react": "^7.22.0",
"eslint-plugin-react-hooks": "^4.2.0",
"gh-pages": "^3.1.0",
"prettier": "^2.2.1",
"react": "17.0.1",
"react-dom": "17.0.1",
"sass": "^1.32.5",
"sass-loader": "^10.1.1",
"style-loader": "^2.0.0"
"react-dom": "17.0.1"
},
"peerDependencies": {
"react": "16.x || 17.x",
Expand Down
85 changes: 0 additions & 85 deletions src/stories/Area.stories.js

This file was deleted.

82 changes: 0 additions & 82 deletions src/stories/Colors.stories.js

This file was deleted.

21 changes: 0 additions & 21 deletions src/stories/Dynamic.stories.js

This file was deleted.

78 changes: 0 additions & 78 deletions src/stories/Map.stories.js

This file was deleted.

Loading

0 comments on commit d953e7d

Please sign in to comment.