Prepping for v.0.1.0 release

README.md

@@ -5,8 +5,6 @@
 [![Build Status](https://github.com/jacobsky/egui-stylist/workflows/CI/badge.svg)](https://github.com/jacobsky/egui-stylist/actions?workflow=CI)
 ![MIT](https://img.shields.io/badge/license-MIT-blue.svg)
 
-> *Note* this project is considered to be experimental and -- while used in personal projects -- may have API breaking changes without warning until 0.1.0 where this repo will start following normal [Cargo's Semantic Versioning](https://doc.rust-lang.org/cargo/reference/semver.html) for API changes.
-
 This project is to help create reusable themes that can be serialized into and from egui. This way it should be much easier to track, design and skin egui natively inside of egui.
 
 This library also strives to be embeddable into any existing application and was built with the intent of embedding itself as an editor script in [Godot Engine](https://godotengine.org/) leveraging [godot-egui](https://github.com/setzer22/godot-egui)
@@ -18,18 +16,18 @@ This library is available as a native application which can be built using `carg
 
 This library is built with [egui](https://docs.rs/egui/) and can be run as a widget in any egui application. To do so, include this application as a dependency in your Cargo.toml file and use the `StylerState` and `EguiTheme` types directly directly.
 
+See more about this in the [egui-stylist](egui-stylist/README.md) readme file.
 
 ## Road Map
 
-- [ ] Improve UX for the theme and font editor
-- [ ] Stablize the API for version 0.2.0
 - [ ] Enhance the Theme Previewer to move away from the using the Demo widget gallery and be more comprehensive
 - [ ] Theme inspector
 - [ ] Small set of selected default themes
 ## Contributions
 
 Contributions to should be made in the form of GitHub pull requests. I will be happy to review and include any additional changes that make sense for the project.
 
-Please make sure to run `cargo fmt` and `cargo clippy` before submitting your pull requests. To keep the main repository as clean as possible, please also ensure that the repository has any `warnings` from the compiler fixed. Also, as `egui` does not require any use of `unsafe` at this moment, unsafe is considered to be forbidden
+Please make sure to run `cargo fmt` and `cargo clippy` before submitting your pull requests. To keep the main repository as clean as possible, please also ensure that the repository has any `warnings` from the compiler fixed. Also, as `egui` does not require any use of `unsafe` at this moment, usage of unsafe is currently forbidden in this project.
 
 All contributions freely made to this projects are licensed as per the terms of the MIT License.
+

egui-stylist-native/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "egui-stylist-native"
-version = "0.0.5"
+version = "0.1.0"
 authors = ["Jacobsky"]
 edition = "2018"
 description="The native application for egui-stylist"
@@ -21,8 +21,8 @@ path = "src/main.rs"
 # crate-type = ["cdylib"]
 
 [dependencies]
-egui-theme = { version = "0.0.5", path = "../egui-theme"}
-egui-stylist = { version = "0.0.5", path = "../egui-stylist"}
+egui-theme = { path = "../egui-theme"}
+egui-stylist = { path = "../egui-stylist"}
 # Gives us egui, epi and web+native backends
 eframe = "0.14.0"
 # Required for font serialization

egui-stylist-native/README.md

@@ -1,6 +1,6 @@
-# egui-stylist: An embeddable application for creating egui-themes
-[![Latest version](https://img.shields.io/crates/v/egui-stylist.svg)](https://crates.io/crates/egui-stylist)
-[![Documentation](https://docs.rs/egui-stylist/badge.svg)](https://docs.rs/egui-stylist)
+# egui-stylist-native: A native application for egui projects.
+[![Latest version](https://img.shields.io/crates/v/egui-stylist-native.svg)](https://crates.io/crates/egui-stylist-native)
+[![Documentation](https://docs.rs/egui-stylist-native/badge.svg)](https://docs.rs/egui-stylist-native)
 ![MIT](https://img.shields.io/badge/license-MIT-blue.svg)
 
 This is the crate that can be used to run egui stylist natively on any of the supported platforms.

egui-stylist/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "egui-stylist"
-version = "0.0.5"
+version = "0.1.0"
 authors = ["Jacobsky"]
 edition = "2018"
 description="An embeddable theme editor for egui."
@@ -15,7 +15,7 @@ path = "src/lib.rs"
 crate-type = ["rlib"]
 
 [dependencies]
-egui-theme = { version = "0.0.5", path = "../egui-theme"}
+egui-theme = { version = "0.1.0", path = "../egui-theme"}
 # Gives us egui, epi and web+native backends
 # eframe = "0.14.0"
 egui = {version = "0.14.2", features = ["persistence"]}

egui-stylist/src/views/mod.rs

@@ -35,8 +35,9 @@ enum StylerTab {
 ///
 /// This can easily be embedded into any existing egui application by calling `ui` from within the egui context such as follows:
 ///
-/// ```
-/// egui::CentralPanel::default().show(ctx, |ui| self.state.ui(ui));
+/// ```ignore
+/// let state = StylistState::default():
+/// egui::CentralPanel::default().show(ctx, |ui| state.ui(ui));
 /// ```
 
 #[derive(Serialize, Deserialize)]

egui-theme/Cargo.toml

@@ -1,6 +1,6 @@
 [package]
 name = "egui-theme"
-version = "0.0.5"
+version = "0.1.0"
 authors = ["Jacobsky"]
 edition = "2018"
 description="A standalone serializable theme container for use with Egui."

egui-theme/README.md

@@ -1,6 +1,6 @@
-# egui-stylist: An embeddable application for creating egui-themes
-[![Latest version](https://img.shields.io/crates/v/egui-stylist.svg)](https://crates.io/crates/egui-stylist)
-[![Documentation](https://docs.rs/egui-stylist/badge.svg)](https://docs.rs/egui-stylist)
+# egui-theme: A container for reproducible styles and visual information between egui applications.
+[![Latest version](https://img.shields.io/crates/v/egui-theme.svg)](https://crates.io/crates/egui-theme)
+[![Documentation](https://docs.rs/egui-theme/badge.svg)](https://docs.rs/egui-theme)
 ![MIT](https://img.shields.io/badge/license-MIT-blue.svg)
 
 `egui-theme` defines a common interface for serializing and storing [egui](https://crates.io/crates/egui)'s style and font data for use between applications. The goal is to allow users of `egui` to easily create and share themes between relevant applications.