antontranelis/utopia-ui
1
0
Fork 0
mirror of https://github.com/utopia-os/utopia-ui.git synced 2025-12-13 07:46:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

refactor(docu): reference the docu URL in the README.md (#125)

Browse Source 
* docs: reference the URL in the README.md

Link to the docs published on github when pushing to `main` and include
percentage badge for documentation coverage.

* corrected typo

* corrected typo
This commit is contained in:
Ulf Gebhardt 2025-02-18 10:15:14 +01:00 committed by GitHub
parent d6c7481661
commit 876d5925e0
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -1,4 +1,4 @@
# Utopia UI [![npm version](https://img.shields.io/npm/v/utopia-ui.svg)](https://www.npmjs.com/package/utopia-ui) ![Build Status](https://img.shields.io/github/actions/workflow/status/utopia-os/utopia-ui/test.build.yml?branch=main) ![License](https://img.shields.io/github/license/utopia-os/utopia-ui) # Utopia UI [![npm version](https://img.shields.io/npm/v/utopia-ui.svg)](https://www.npmjs.com/package/utopia-ui) ![Build Status](https://img.shields.io/github/actions/workflow/status/utopia-os/utopia-ui/test.build.yml?branch=main) [![Docs Coverage](https://utopia-os.org/utopia-ui/coverage.svg)](https://utopia-os.org/utopia-ui/) ![License](https://img.shields.io/github/license/utopia-os/utopia-ui)
**UI Framework for Real-Life-Networking-Apps** **UI Framework for Real-Life-Networking-Apps**
@ -26,9 +26,11 @@ It is the base of [Utopia Map](https://github.com/utopia-os/utopia-map) and [Uto
## Getting Started ## Getting Started
1. If you want to use **Utopia UI** in your project, check out [`/exampes`](/examples) to see how to use its components. 1. If you want to use **Utopia UI** in your project, check out [`/examples`](/examples) to see how to use its components.
2. If you like to contribute to our library, see the [Contribution Guide](/CONTRIBUTING.md) to see how to setup a development environment on your local machine. 2. If you need more information you can explore [the docs](https://utopia-os.org/utopia-ui/)
3. If you like to contribute to our library, see the [Contribution Guide](/CONTRIBUTING.md) to see how to setup a development environment on your local machine.
## Components ## Components