Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
eimrek committed Mar 26, 2024
1 parent d7b71a8 commit 478c342
Showing 1 changed file with 17 additions and 11 deletions.
28 changes: 17 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# React Materials Cloud Band Structure Visualizer

[![NPM Version](https://img.shields.io/npm/v/mc-react-bands)](https://www.npmjs.com/package/mc-react-bands)

A React component to visualize band structures and density of states (dos) on the Materials Cloud platform.

The `BandsVisualizer` component (only the folder `src/lib`) is published as a npm package, which can be installed via `npm install mc-react-bands`.
Expand Down Expand Up @@ -39,23 +41,27 @@ export default App;

This repository also contains example usage in the `src/App.jsx` file. `src/data` contains the data format of the band and dos files.

The core of this app is based on `jquery` and `chart.js`.

Related repositories:

- https://github.com/osscar-org/widget-bandsplot (corresponding Jupyter widget)
- https://github.com/materialscloud-org/bands-widget (original, outdated version used in legacy Materials Cloud)

## Development

For local development, and running the example, just install and run this repository:

```
npm install
npm run dev
```

To publish a new version on npm:
### Publishing a new version

```
npm run build
npm publish
```

The core of this app is based on `jquery` and `chart.js`.
To make a new version and publish to npm via GitHub Actions:

Related repositories:

- https://github.com/materialscloud-org/bands-widget (original, outdated version used in legacy Materials Cloud)
- https://github.com/aiidalab/widget-bandsplot (corresponding AiiDAlab widget, that should be adapted to use this repository)
```bash
npm version <patch/minor/major>
git push --follow-tags
```

0 comments on commit 478c342

Please sign in to comment.