Skip to content
This repository has been archived by the owner on Jun 25, 2024. It is now read-only.

Commit

Permalink
Merge pull request #30 from northis/f/29
Browse files Browse the repository at this point in the history
F/29, Markdown readme
  • Loading branch information
northis authored Nov 6, 2019
2 parents 3118d09 + 90ac08d commit a575632
Show file tree
Hide file tree
Showing 3 changed files with 28 additions and 0 deletions.
27 changes: 27 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,36 @@ Telegram bot @ChineseDuckBot to study Chinese language via memorizing flashcards
- Pre-installed cards for HSK1, HSK2,... to bulk import to a separate folder.
Now available HSK1-6 pre-installed folders: english & russain versions

<img src="images/learning.png" alt="Leadning in bot" height="400" />

## Commands

- /About - 🈴About this bot
- /Add - ➕Add a new chinese word
- /Default - 👌Set default mode
- /Delete - 🗑Remove a word from the dictionary
- /Edit - 🖌Edit an existing chinese word
- /Folder - 🗀Manage your current folder
- /Import - 🚛Import words from a file
- /Help - ❓List of available commands
- /LearnPronunciation - 📢Learn how to pronounce these words
- /LearnTranslation - 🇨🇳Learn what these words mean
- /LearnView - 🎓👀Just view these words
- /LearnWriting - 🖌Learn how to write these words
- /Mode - ⚙️Choose learn words mode
- /PreInstall - 🗀🕮Get pre-installed folders
- /Start - 🖐Welcome
- /View - 👀View a flash card
- /Web - 🌐Manage the web-part of the bot

## Roadmap

- Using webpart to manipulating the words
- Wiki-part
- Change domain
- More languages in csv templates
- Fix bugs & implement features
- Improve deploy & changelog

## API

Expand Down
Binary file added images/learning.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions src/bot/chineseDuck.BotService/ReleaseNotes.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@ Release notes:
ver.0.7.0 (29 october 2019)
=========================
[+] HSK 1-6 pre-installed folder for English and Russian languages
[+] Usage property support

ver.0.6.1.0 (22 october 2019)
=========================
Expand Down

0 comments on commit a575632

Please sign in to comment.