From 57515a4470180847f53558dd4079051ea164420d Mon Sep 17 00:00:00 2001
From: Skoropad Aleksandr <askoropad@solit-clouds.ru>
Date: Mon, 3 May 2021 13:43:30 +0300
Subject: [PATCH] fix(project): build

---
 README.md | 43 ++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 42 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 79c94ee..88b756d 100644
--- a/README.md
+++ b/README.md
@@ -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)