aboutsummaryrefslogtreecommitdiffhomepage
path: root/README.md
diff options
context:
space:
mode:
authorOkke Formsma <[email protected]>2020-11-06 14:41:12 +0100
committerPete Johanson <[email protected]>2020-11-22 21:06:42 -0500
commitf5ecf761a36f4bc79a77fdc2217cd45acc1eb5d8 (patch)
tree927b5063338c221355e4638b4390c57645fabf0b /README.md
parent6573483a1096a1ab91c459a30e08665b1161b8fa (diff)
downloadzmk-f5ecf761a36f4bc79a77fdc2217cd45acc1eb5d8.tar.gz
zmk-f5ecf761a36f4bc79a77fdc2217cd45acc1eb5d8.zip
update README.md with up-to-date info
Diffstat (limited to 'README.md')
-rw-r--r--README.md5
1 files changed, 2 insertions, 3 deletions
diff --git a/README.md b/README.md
index cde1ffae77..3fc53a5cdb 100644
--- a/README.md
+++ b/README.md
@@ -4,11 +4,10 @@
[![Build](https://github.com/zmkfirmware/zmk/workflows/Build/badge.svg)](https://github.com/zmkfirmware/zmk/actions)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-v2.0%20adopted-ff69b4.svg)](CODE_OF_CONDUCT.md)
-This project is a complete work in progress, with only basic things functioning. The goal is to explore a new MK firmware
-with a less restrictive license and better BLE support, built on top of the [Zephyr™ Project](https://www.zephyrproject.org/)
+[ZMK Firmware](https://zmkfirmware.dev/) is an open source (MIT) keyboard firmware built on the [Zephyr™ Project](https://www.zephyrproject.org/) Real Time Operating System (RTOS). ZMK's goal is to provide a modern, wireless, and powerful firmware free of licensing issues.
Check out the website to learn more: https://zmkfirmware.dev/
You can also come join our [ZMK Discord Server](https://zmkfirmware.dev/community/discord/invite)
-To review planned features, check out the [enhancement label](https://github.com/zmkfirmware/zmk/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) in GitHub. Please feel free to add 👍 to the issue description of any requests to upvote the feature.
+To review features, check out the [feature overview](https://zmkfirmware.dev/docs/). ZMK is under active development, and new features are listed with the [enhancement label](https://github.com/zmkfirmware/zmk/issues?q=is%3Aissue+is%3Aopen+label%3Aenhancement) in GitHub. Please feel free to add 👍 to the issue description of any requests to upvote the feature.