Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
caro3801 authored Mar 18, 2024
1 parent 05ae7d0 commit c29f579
Showing 1 changed file with 15 additions and 19 deletions.
34 changes: 15 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,40 +3,42 @@
<img src="https://github.com/ICIJ/murmur/raw/master/lib/assets/images/murmur-dark.png" width="158px">
</a>
<br>
Murmur is <a href="https://icij.org">ICIJ</a>'s Design System for Bootstrap 4 and Vue.js
Murmur is <a href="https://icij.org">ICIJ</a>'s Design System for Bootstrap 5 and Vue.js
</p>

<div align="center">

| | Status |
| --: | :-- |
| **CI checks** | [![CircleCI](https://circleci.com/gh/ICIJ/murmur.svg?style=shield)](https://circleci.com/gh/ICIJ/murmur) |
| **Github Actions** | ![Github Actions](https://github.com/ICIJ/murmur-next/actions/workflows/deploy-github-pages.yaml/badge.svg) |
| **Code Climate** | [![Code Climate](https://api.codeclimate.com/v1/badges/e487295b939be72d5f15/maintainability)](ttps://codeclimate.com/github/ICIJ/murmur/maintainability) |
| **NPM version** | [![NPM version](https://img.shields.io/npm/v/@icij/murmur)](https://www.npmjs.com/package/@icij/murmur) |
| **NPM downloads** | [![NPM download](https://img.shields.io/npm/dm/@icij/murmur)](https://www.npmjs.com/package/@icij/murmur) |
| **NPM version** | [![NPM version](https://img.shields.io/npm/v/@icij/murmur-next)](https://www.npmjs.com/package/@icij/murmur-next) |
| **NPM downloads** | [![NPM download](https://img.shields.io/npm/dm/@icij/murmur-next)](https://www.npmjs.com/package/@icij/murmur-next) |

</div>


## Installation guide

If you are using module bundlers such as Webpack or Rollup, you might need to include the package into your project.
If you are using module bundlers such as Webpack or Vite, you might need to include the package into your project.
To get started, use NPM or Yarn to get latest version of **@icij/murmur**.

```bash
# with NPM:
npm i @icij/murmur
npm i @icij/murmur-next

# or with Yarn:
yarn add @icij/murmur
yarn add @icij/murmur-next
```
Then, register Murmur as a pluggin in your app entry point:

```js
import Vue from 'vue'
import Murmur from '@icij/murmur'
import {createApp} from 'vue'
import Murmur from '@icij/murmur-next'

Vue.use(Murmur)

const app = createApp({})
app.use(Murmur)
```

Now all components will be globally available in your app.
Expand All @@ -54,18 +56,12 @@ yarn serve
# build library and documentation for production with minification
yarn build

# build library for production with minification
yarn build:lib

# build documentation for production with minification
yarn build:docs

# deploy the doc on Github Pages
yarn deploy
# build storybook documentation for production
yarn build-storybook

# publish a version of the package on NPM registry
yarn publish

# run unit tests
yarn test:unit
yarn test
```

0 comments on commit c29f579

Please sign in to comment.