Merge pull request #64 from hecrj/improvement/update-readmes

Update repository documentation

2 files changed, 26 insertions, 1 deletions

diff --git a/core/Cargo.toml b/core/Cargo.toml
index f2492345..c623ba78 100644
--- a/core/Cargo.toml
+++ b/core/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "iced_core"
-version = "0.1.0-alpha"
+version = "0.1.0"
 authors = ["Héctor Ramón Jiménez <hector0193@gmail.com>"]
 edition = "2018"
 description = "The essential concepts of Iced"
diff --git a/core/README.md b/core/README.md
new file mode 100644
index 00000000..31630ea8
--- /dev/null
+++ b/core/README.md
@@ -0,0 +1,25 @@
+# `iced_core`
+[![Documentation](https://docs.rs/iced_core/badge.svg)][documentation]
+[![Crates.io](https://img.shields.io/crates/v/iced_core.svg)](https://crates.io/crates/iced_core)
+[![License](https://img.shields.io/crates/l/iced_core.svg)](https://github.com/hecrj/iced/blob/master/LICENSE)
+[![project chat](https://img.shields.io/badge/chat-on_zulip-brightgreen.svg)](https://iced.zulipchat.com)
+
+`iced_core` holds basic reusable types of the public API. For instance, basic data types like `Point`, `Rectangle`, `Length`, etc.
+
+This crate is meant to be a starting point for an Iced runtime.
+
+![iced_core](../docs/graphs/core.png)
+
+[documentation]: https://docs.rs/iced_core
+
+## Installation
+Add `iced_core` as a dependency in your `Cargo.toml`:
+
+```toml
+iced_core = "0.1.0"
+```
+
+__Iced moves fast and the `master` branch can contain breaking changes!__ If
+you want to learn about a specific release, check out [the release list].
+
+[the release list]: https://github.com/hecrj/iced/releases