docs: Add bare-bones README files

JadedBlueEyes · Jul 12, 2024 · 6861793 · 6861793
1 parent 773a226
commit 6861793
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 2 deletions.
diff --git a/README.md b/README.md
@@ -1,7 +1,11 @@
 # MessageFormat
 
-[![CI status](https://github.com/JadedBlueEyes/messageformat/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/JadedBlueEyes/messageformat/actions/workflows/ci.yml?query=branch%3Amain) [![dependency status](https://deps.rs/repo/github/JadedBlueEyes/messageformat/status.svg?path=crates%2Fmf1)](https://deps.rs/repo/github/JadedBlueEyes/messageformat?path=crates%2Fmf1) [![Last commit](https://img.shields.io/github/last-commit/JadedBlueEyes/messageformat.svg?logo=github&logoColor=white)](https://github.com/JadedBlueEyes/messageformat/commits/main/) [![pre-commit enabled](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+[![CI status](https://github.com/JadedBlueEyes/messageformat/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/JadedBlueEyes/messageformat/actions/workflows/ci.yml?query=branch%3Amain) [![Dependency status](https://deps.rs/repo/github/JadedBlueEyes/messageformat/status.svg?path=crates%2Fmf1)](https://deps.rs/repo/github/JadedBlueEyes/messageformat?path=crates%2Fmf1) [![Last commit](https://img.shields.io/github/last-commit/JadedBlueEyes/messageformat.svg?logo=github&logoColor=white)](https://github.com/JadedBlueEyes/messageformat/commits/main/) [![pre-commit enabled](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
 
 MessageFormat is a collection of crates to help with internationalising Rust applications using ICU MessageFormat.
 
+- [mf1](./crates/mf1/)
+- [mf1-macros](./crates/mf1-macros/)
+- [mf1-parser](./crates/mf1/-parser)
+
 Take a look at the [basic example](https://github.com/JadedBlueEyes/messageformat/blob/main/examples/basic/).
diff --git a/crates/mf1-macros/README.md b/crates/mf1-macros/README.md
@@ -0,0 +1,9 @@
+# mf1-macros
+
+![Last commit](https://img.shields.io/github/last-commit/JadedBlueEyes/messageformat?path=crates%2Fmf1-macros) [![Dependency status](https://deps.rs/repo/github/JadedBlueEyes/messageformat/status.svg?path=crates%2Fmf1-macros)](https://deps.rs/repo/github/JadedBlueEyes/messageformat?path=crates%2Fmf1-macros)
+
+Macros for the [mf1](../mf1/README.md) crate
+
+[CHANGELOG](CHANGELOG.md)
+
+License: MIT OR Apache-2.0
diff --git a/crates/mf1-parser/README.md b/crates/mf1-parser/README.md
@@ -0,0 +1,9 @@
+# mf1-parser
+
+![Last commit](https://img.shields.io/github/last-commit/JadedBlueEyes/messageformat?path=crates%2Fmf1-parser) [![Dependency status](https://deps.rs/repo/github/JadedBlueEyes/messageformat/status.svg?path=crates%2Fmf1-parser)](https://deps.rs/repo/github/JadedBlueEyes/messageformat?path=crates%2Fmf1-parser)
+
+Parse ICU MessageFormat 1 syntax
+
+[CHANGELOG](CHANGELOG.md)
+
+License: MIT OR Apache-2.0
diff --git a/crates/mf1/Cargo.toml b/crates/mf1/Cargo.toml
@@ -3,7 +3,7 @@ name = "mf1"
 version = "0.1.0"
 edition = "2021"
 license = "MIT OR Apache-2.0"
-description = "Use ICU Messageformat 1 to internationalise your apps"
+description = "Use ICU MessageFormat 1 to internationalise your apps"
 
 [dependencies]
 

diff --git a/crates/mf1/README.md b/crates/mf1/README.md
@@ -0,0 +1,9 @@
+# mf1
+
+![Last commit](https://img.shields.io/github/last-commit/JadedBlueEyes/messageformat?path=crates%2Fmf1) [![Dependency status](https://deps.rs/repo/github/JadedBlueEyes/messageformat/status.svg?path=crates%2Fmf1)](https://deps.rs/repo/github/JadedBlueEyes/messageformat?path=crates%2Fmf1)
+
+Use ICU MessageFormat 1 to internationalise your apps
+
+[CHANGELOG](CHANGELOG.md)
+
+License: MIT OR Apache-2.0