Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
eimrek committed Jul 23, 2024
1 parent d129a7b commit 2752c12
Show file tree
Hide file tree
Showing 2 changed files with 224 additions and 169 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,23 @@ npm install mc-react-library

Note: make sure all `peerDependencies` (defined in `package.json`) are installed in the host application!

And use with

```javascript
import {
DoiBadge,
HelpButton,
McloudSpinner,
...
} from "mc-react-library";
```

Note: see usage examples of each component in the demo page.

Project structure:

- `lib\` - contains the React components of the library.
- `src\` - contains a demo page that renders the components just for development.
- `src\` - contains a demo page that renders the components for development.

## Development

Expand Down Expand Up @@ -48,6 +61,6 @@ npm install /path/to/mc-react-library-x.y.z.tgz
To make a new version and publish to npm via GitHub Actions:

```bash
npm version <patch/minor/major>
npm version <major/minor/patch>
git push --follow-tags
```
Loading

0 comments on commit 2752c12

Please sign in to comment.