mirror of
https://github.com/mue/mue.git
synced 2026-07-26 18:21:27 +02:00
feat: add translation percentage tracking and update related components
This commit is contained in:
17
README.md
17
README.md
@@ -6,7 +6,6 @@
|
||||
|
||||
<p align="center"><a href="https://muetab.com">muetab.com</a></p>
|
||||
|
||||
|
||||
<div align="center">
|
||||
|
||||
[](https://chromewebstore.google.com/detail/mue/bngmbednanpcfochchhgbkookpiaiaid)
|
||||
@@ -15,9 +14,8 @@
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
## 🤔 Why Mue?
|
||||
|
||||
- Beautiful and Minimalist Design
|
||||
- Customisable Layout
|
||||
- Widgets (such as weather, notes, bookmarks and more)
|
||||
@@ -26,6 +24,7 @@
|
||||
- Open Source under the BSD-3 License
|
||||
|
||||
## 🌶️ Installation
|
||||
|
||||
Mue can be downloaded on the following browsers:
|
||||
|
||||
- [Chrome](https://chromewebstore.google.com/detail/mue/bngmbednanpcfochchhgbkookpiaiaid)
|
||||
@@ -35,21 +34,23 @@ Mue can be downloaded on the following browsers:
|
||||
|
||||
and can be manually sideloaded on others using the files on [GitHub Releases](https://github.com/mue/mue/releases)
|
||||
|
||||
|
||||
## 🚀 Demo
|
||||
|
||||
A fully-featured demo of the tab extension is available in-browser at [demo.muetab.com](https://demo.muetab.com)
|
||||
|
||||
|
||||
## 💻 Development
|
||||
Install dependencies with ``bun install``, and then you can run any of the following scripts as needed:
|
||||
|
||||
Install dependencies with `bun install`, and then you can run any of the following scripts as needed:
|
||||
|
||||
- `bun run dev[:host]` - start development server
|
||||
- `bun run build` - build production copy of Mue
|
||||
- `bun run lint[:fix]` - run linter
|
||||
- `bun run pretty` - run prettier
|
||||
- `bun run translations` - migrate old translation format to new
|
||||
- `bun run translations:percentages` - update translation completion percentages from Weblate
|
||||
|
||||
## 🐳 Docker development
|
||||
|
||||
Hot reload is available while coding.
|
||||
|
||||
- `docker build -t mue-app .` - build the image
|
||||
@@ -61,14 +62,16 @@ Hot reload is available while coding.
|
||||
- `docker run -p 5173:5173 \
|
||||
-v $(pwd):/app \
|
||||
-v dev-bun-app:/app/node_modules \
|
||||
mue-app
|
||||
mue-app
|
||||
` - run the container
|
||||
|
||||
Navigate to http://localhost:5173
|
||||
|
||||
## 🌍 Translations
|
||||
|
||||
We use [Weblate](https://weblate.org) for translations. To get started, please visit the [project](https://hosted.weblate.org/projects/mue/) and look for the latest version to start translating Mue into your langauge.
|
||||
|
||||
## Attribution
|
||||
|
||||
[Pexels](https://pexels.com), [Unsplash](https://unsplash.com) - Stock photos used for offline mode <br/>
|
||||
[Undraw](https://undraw.co) - Welcome modal images
|
||||
|
||||
Reference in New Issue
Block a user