monkeytype/README.md

53 lines
2.8 KiB
Markdown
Raw Normal View History

[![](https://github.com/monkeytypegame/monkeytype/blob/master/frontend/static/images/githubbanner2.png?raw=true)](https://monkeytype.com/)
<br />
2022-07-06 17:22:57 +08:00
![TypeScript](https://img.shields.io/badge/typescript-%23007ACC.svg?style=for-the-badge&logo=typescript&logoColor=white)
![SASS](https://img.shields.io/badge/SASS-hotpink.svg?style=for-the-badge&logo=SASS&logoColor=white)
![HTML5](https://img.shields.io/badge/html5-%23E34F26.svg?style=for-the-badge&logo=html5&logoColor=white)
2021-03-02 22:33:38 +08:00
# About
2020-08-12 05:02:25 +08:00
Monkeytype is a minimalistic and customizable [typing test](https://www.monkeytype.com). It features many test modes, an account system to save your typing speed history, and user-configurable features such as themes, sounds, a smooth caret, and more. Monkeytype attempts to emulate a natural typing experience during a typing test by unobtrusively presenting the text prompts and displaying typed characters in place, providing straightforward, real-time feedback on typos, speed, and accuracy.
2020-05-15 02:03:05 +08:00
2021-03-02 22:33:38 +08:00
# Features
2020-08-12 05:02:25 +08:00
- minimalistic design, with optional advertisements and focus mode while typing
- type what you see, see what you type
- live errors, wpm, and accuracy displays
- a variety of test lengths and languages
- punctuation and numbers modes
2021-04-14 05:28:37 +08:00
- quotes
- themes
2020-05-15 21:45:44 +08:00
- smooth caret
- account system
- challenges and just-for-fun test modifiers
2020-06-28 07:17:29 +08:00
- and much more
2020-05-15 21:45:44 +08:00
2021-03-02 22:33:38 +08:00
# Discord bot
2020-08-12 05:02:25 +08:00
On the [Monkeytype Discord server](https://www.discord.gg/monkeytype), we added a Discord bot to auto-assign optional roles based on typing performance and challenge completion. You can find its code over at https://github.com/monkeytypegame/monkeytype-bot.
2020-07-08 04:15:48 +08:00
2021-03-02 22:33:38 +08:00
# Bug report or Feature request
2020-08-12 05:02:25 +08:00
2023-02-14 07:22:37 +08:00
If you encounter a bug or have a feature request, [send us an email](mailto:contact@monkeytype.com), [create an issue](https://github.com/monkeytypegame/monkeytype/issues), [create a discussion thread](https://github.com/monkeytypegame/monkeytype/discussions), or [join the Discord server](https://www.discord.gg/monkeytype).
2020-05-15 02:03:05 +08:00
2021-09-30 00:04:10 +08:00
# Want to Contribute?
2021-04-09 01:34:51 +08:00
Refer to [CONTRIBUTING.md](./CONTRIBUTING.md).
2021-04-09 01:34:51 +08:00
# Code of Conduct
2021-04-09 01:34:51 +08:00
Before contributing to this repository, please read the [code of conduct](./CODE_OF_CONDUCT.md).
2021-04-14 05:28:37 +08:00
2021-03-02 22:33:38 +08:00
# Credits
2020-08-12 05:02:25 +08:00
2021-04-14 05:28:37 +08:00
[Montydrei](https://www.reddit.com/user/montydrei) for the name suggestion.
2020-11-02 23:06:58 +08:00
Everyone who provided valuable feedback on the [original Reddit post](https://www.reddit.com/r/MechanicalKeyboards/comments/gc6wx3/experimenting_with_a_completely_new_type_of/) for the prototype of this website.
2020-11-02 23:06:58 +08:00
All of the [contributors](https://github.com/monkeytypegame/monkeytype/graphs/contributors) have helped implement various features, add themes, fix bugs, and more.
2021-03-02 22:33:38 +08:00
# Support
2020-08-12 05:02:25 +08:00
2022-01-30 21:23:51 +08:00
If you wish to support further development and feel extra awesome, you can [donate](https://ko-fi.com/monkeytype), [become a Patron](https://www.patreon.com/monkeytype) or [buy a t-shirt](https://www.monkeytype.store/).