From 4ead124a2a19934b0b9260933bb4c970168d4960 Mon Sep 17 00:00:00 2001 From: Marie Date: Fri, 22 Dec 2023 01:52:03 +0100 Subject: [PATCH] upd: README --- README.md | 19 +++++++------------ 1 file changed, 7 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index afdccf7..598c4c3 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,10 @@ -# mfm.js -An MFM parser implementation with TypeScript. -[Try it out!](https://runkit.com/npm/mfm-js) - -[![Test](https://github.com/misskey-dev/mfm.js/actions/workflows/test.yml/badge.svg)](https://github.com/misskey-dev/mfm.js/actions/workflows/test.yml) -[![codecov](https://codecov.io/gh/misskey-dev/mfm.js/branch/develop/graph/badge.svg?token=irAWFiHK8T)](https://codecov.io/gh/misskey-dev/mfm.js) - -[![NPM](https://nodei.co/npm/mfm-js.png?downloads=true&downloadRank=true&stars=true)](https://www.npmjs.com/package/mfm-js) +# sfm.js +An SFM parser implementation with fixes based on MFM ## Installation ``` -npm i mfm-js +npm config set @sharkey:registry https://git.joinsharkey.org/api/packages/Sharkey/npm/ +npm i @sharkey/sfm-js ``` ## Usage @@ -17,7 +12,7 @@ Please see [docs](./docs/index.md) for the detail. TypeScript: ```ts -import * as mfm from 'mfm-js'; +import * as mfm from '@sharkey/sfm-js'; const inputText = `
@@ -42,12 +37,12 @@ const text = mfm.toString(mfmTree); ## Develop ### 1. Clone ``` -git clone https://github.com/misskey-dev/mfm.js.git +git clone https://git.joinsharkey.org/Sharkey/sfm.js.git ``` ### 2. Install packages ``` -cd mfm.js +cd sfm.js npm i ```