etc/sfm-js
1
0
Fork 0
mirror of https://activitypub.software/TransFem-org/sfm-js synced 2024-11-24 23:15:14 +00:00
Code Issues Projects Releases Packages Wiki Activity

update readme

Browse source
This commit is contained in:
marihachi 2021-03-19 21:16:21 +09:00
parent 486134d8c4
commit 605c6585c7
1 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -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!***');
@ -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
```