Skip to content

Commit

Permalink
Add new updated READMEs (#55)
Browse files Browse the repository at this point in the history
* Add new updated READMEs

* Create cool-pumas-flash.md
  • Loading branch information
yanthomasdev authored Nov 24, 2023
1 parent 0c33779 commit 060b99a
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 11 deletions.
5 changes: 5 additions & 0 deletions .changeset/cool-pumas-flash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@lunariajs/core": patch
---

Update README
24 changes: 17 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,21 @@
# Lunaria
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://github.com/Yan-Thomas/lunaria/assets/61414485/d89b6221-403c-465c-821a-5d02b339590c">
<source media="(prefers-color-scheme: light)" srcset="https://github.com/Yan-Thomas/lunaria/assets/61414485/cfe14a43-e87d-4d8a-9285-651017f1f6e6">
<img alt="Lunaria logo" src="https://github.com/Yan-Thomas/lunaria/assets/61414485/cfe14a43-e87d-4d8a-9285-651017f1f6e6" height="100">
</picture>
<br/>
<br/>
<a href="https://lunaria.dev">Lunaria</a> is the missing localization management toolchain for open-source projects &mdash;
<br/>
great for maintainers, even better for contributors.
<br/><br/>
</p>

Lunaria is an translation management toolchain for open-source projects.
## Status

## Is it ready?
Lunaria is currently in early access and is **not ready to use yet**.

![Yoda lifting his head, with the caption "patience you must learn"](https://media.tenor.com/5AwAZOY-F94AAAAd/star-wars-yoda.gif)
## Documentation

## Credits

This project was created based on the internationalization tooling built by the Astro community. Special thanks to [Hippo](https://github.com/hippotastic) (creator of i18n Tracker) and [TheOtterlord](https://github.com/TheOtterlord) (for continued improvements to it).
Read the official [Lunaria documentation](https://lunaria.dev) to learn more and get started.
6 changes: 2 additions & 4 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,8 @@
# `@lunariajs/core`

The `@lunariajs/core` package contains the base tracking and dashboard generation systems used across its related packages. You should use this package if:
The `@lunariajs/core` package contains the base tracking and dashboard generation systems used across the toolchain.

- You need fine-grained control over your dashboard
- You want to build a package over it
- There isn't a framework-specific `@lunariajs` package for your use-case
Read the official [Lunaria documentation](https://lunaria.dev) to learn more about it.

## Installation

Expand Down

0 comments on commit 060b99a

Please sign in to comment.