Skip to content

Commit

Permalink
fix(project): build
Browse files Browse the repository at this point in the history
  • Loading branch information
Skoropad Aleksandr committed May 3, 2021
1 parent 194d106 commit 57515a4
Showing 1 changed file with 42 additions and 1 deletion.
43 changes: 42 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,42 @@
Description 1
# Telegramify-Markdown

[![CircleCI](https://circleci.com/gh/skoropadas/telegramify-markdown.svg?style=svg)](https://circleci.com/gh/skoropadas/telegramify-markdown)

Telegramify-Markdown is a Markdown
to [Telegram-specific-markdown](https://core.telegram.org/bots/api#formatting-options) converter, based
on [Unified](https://github.com/unifiedjs/unified) and [Remark](https://github.com/remarkjs/remark/).

## Install

```bash
npm install telegramify-markdown
```

## Usage

```js
const telegramifyMarkdown = require('telegramify-markdown');
const markdown = `
# List of items
* item 1
* item 2
* item 3
[here is an example.](https://example.com)
`;

telegramifyMarkdown(markdown);
/*
*List of items*
• item 1
• item 2
• item 3
[here is an example\.](https://example.com)
/
*
```
[MIT Licence](LICENSE)

0 comments on commit 57515a4

Please sign in to comment.