Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
marihachi committed Mar 19, 2021
1 parent 486134d commit 605c658
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# mfm-parser-pegjs
# rosee
## Description
A MFM parser implementation with PEG.js (In developing)

## Installation
```
npm i mfm-parser-pegjs
npm i rosee
```

## Usage
TypeScript:
```ts
import * as mfm from 'mfm-parser-pegjs';
import * as mfm from 'rosee';

// parse a MFM text
const result = mfm.parse('good morning ***everynyan!***');
Expand All @@ -22,12 +22,12 @@ const plainResult = mfm.parsePlain('I like the hot soup :soup:​');
## Usage (Repository)
### 1. Clone
```
git clone https://github.com/marihachi/mfm-parser-pegjs.git
git clone https://github.com/marihachi/rosee.git
```

### 2. Install packages
```
cd mfm-parser-pegjs
cd rosee
npm i
```

Expand Down

0 comments on commit 605c658

Please sign in to comment.