From 628669a62597d08767b8ba384533732ac461729a Mon Sep 17 00:00:00 2001 From: Muhammad Hamza Date: Wed, 28 Jul 2021 13:35:42 +0500 Subject: [PATCH] Prepare v0.3.0 release (#148) * bump versions * add blog * fix an old mistake * add "Looking for contributors" note * Update website/blog/2021-07-27-new-release.md Co-authored-by: Simon * Apply suggestions from review * Update READMEs * update gloo version on homepage * Apply suggestions from code review Co-authored-by: Xavientois <34867186+Xavientois@users.noreply.github.com> * Update README.md Co-authored-by: Simon Co-authored-by: Xavientois <34867186+Xavientois@users.noreply.github.com> --- .gitignore | 6 +- Cargo.toml | 2 +- crates/console/Cargo.toml | 2 - crates/dialogs/README.md | 9 ++- crates/events/README.md | 1 - crates/file/README.md | 1 - crates/render/README.md | 1 - crates/storage/README.md | 1 - crates/timers/README.md | 1 - website/blog/2019-05-29-hello-world.md | 2 +- website/blog/2021-07-27-new-release.md | 88 ++++++++++++++++++++++++++ website/src/pages/__index.md | 4 +- 12 files changed, 103 insertions(+), 15 deletions(-) create mode 100644 website/blog/2021-07-27-new-release.md diff --git a/.gitignore b/.gitignore index 89f5fe12..64eef2b1 100644 --- a/.gitignore +++ b/.gitignore @@ -2,5 +2,9 @@ **/*.rs.bk Cargo.lock -guide/book +# editor configs .vscode +.idea + +# hosting cache +.firebase/hosting.*.cache diff --git a/Cargo.toml b/Cargo.toml index 3da70d0f..5ad2289a 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -5,7 +5,7 @@ edition = "2018" license = "MIT/Apache-2.0" name = "gloo" readme = "README.md" -version = "0.2.1" +version = "0.3.0" repository = "https://github.com/rustwasm/gloo" homepage = "https://github.com/rustwasm/gloo" categories = ["api-bindings", "wasm"] diff --git a/crates/console/Cargo.toml b/crates/console/Cargo.toml index 93809bb8..0349409c 100644 --- a/crates/console/Cargo.toml +++ b/crates/console/Cargo.toml @@ -10,8 +10,6 @@ repository = "https://github.com/rustwasm/gloo/tree/master/crates/console" homepage = "https://github.com/rustwasm/gloo" categories = ["api-bindings", "development-tools::profiling", "wasm"] -# See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html - [dependencies] wasm-bindgen = { version = "0.2", features = ["serde-serialize"] } js-sys = "0.3" diff --git a/crates/dialogs/README.md b/crates/dialogs/README.md index 2fb047ea..2a96fc62 100644 --- a/crates/dialogs/README.md +++ b/crates/dialogs/README.md @@ -3,7 +3,6 @@

gloo-dialogs

- Build Status Crates.io version Download docs.rs docs @@ -20,8 +19,12 @@ Built with 🦀🕸 by The Rust and WebAssembly Working Group -This crate provides wrapper for `alert`, `prompt` and `confirm` functions. +This crate provides wrappers for the following functions. +- [`alert`](https://developer.mozilla.org/en-US/docs/Web/API/Window/alert) +- [`confirm`](https://developer.mozilla.org/en-US/docs/Web/API/Window/confirm) +- [`prompt`](https://developer.mozilla.org/en-US/docs/Web/API/Window/prompt) + `web-sys` provides a raw API which is hard to use. This crate provides an easy-to-use, idiomatic Rust API for these functions. -See the documentation for [`alert`], [`prompt`] and [`confirm`] for more information. +See the [API documentation](https://docs.rs/gloo-dialogs) to learn more. diff --git a/crates/events/README.md b/crates/events/README.md index c89e2c65..14e651d7 100644 --- a/crates/events/README.md +++ b/crates/events/README.md @@ -3,7 +3,6 @@

gloo-events

- Build Status Crates.io version Download docs.rs docs diff --git a/crates/file/README.md b/crates/file/README.md index d603415f..1a95f07b 100644 --- a/crates/file/README.md +++ b/crates/file/README.md @@ -3,7 +3,6 @@

gloo-file

- Build Status Crates.io version Download docs.rs docs diff --git a/crates/render/README.md b/crates/render/README.md index 5bc90cc1..b7477dc6 100644 --- a/crates/render/README.md +++ b/crates/render/README.md @@ -3,7 +3,6 @@

gloo-render

- Build Status Crates.io version Download docs.rs docs diff --git a/crates/storage/README.md b/crates/storage/README.md index 3c21fee7..8d327cff 100644 --- a/crates/storage/README.md +++ b/crates/storage/README.md @@ -3,7 +3,6 @@

gloo-storage

- Build Status Crates.io version Download docs.rs docs diff --git a/crates/timers/README.md b/crates/timers/README.md index ce886237..318afbcd 100644 --- a/crates/timers/README.md +++ b/crates/timers/README.md @@ -3,7 +3,6 @@

gloo-timers

- Build Status Crates.io version Download docs.rs docs diff --git a/website/blog/2019-05-29-hello-world.md b/website/blog/2019-05-29-hello-world.md index c7c3b710..37fca4df 100644 --- a/website/blog/2019-05-29-hello-world.md +++ b/website/blog/2019-05-29-hello-world.md @@ -2,7 +2,7 @@ slug: hello-world title: Hello World author: Muhammad Hamza -author_title: Maintainer of Docusaurus +author_title: Maintainer of Gloo author_url: https://github.com/hamza1311 author_image_url: https://avatars.githubusercontent.com/u/47357913?v=4 tags: [hello] diff --git a/website/blog/2021-07-27-new-release.md b/website/blog/2021-07-27-new-release.md new file mode 100644 index 00000000..7fd8156d --- /dev/null +++ b/website/blog/2021-07-27-new-release.md @@ -0,0 +1,88 @@ +--- +slug: release-0.3.0 +title: Releasing v0.3.0 +author: Muhammad Hamza +author_title: Maintainer of Gloo +author_url: https://github.com/hamza1311 +author_image_url: https://avatars.githubusercontent.com/u/47357913?v=4 +tags: [release] +--- + +The Gloo team is happy to announce a new, long overdue, version of Gloo: v0.3.0. +Gloo is a modular toolkit for building fast, reliable Web applications and libraries with Rust and WASM. + +## What's new + +This release focuses on adding new features and crates. + +### New crates + +#### `gloo-console` + +`gloo-console` provides an ergonomic way to access the browser's console API using macros: + +```rust +log!("text"); +``` + +The formatting is done on the browser side. Any `JsValue` can be provided and it'll be logged as-is: + +```rust +let object = JsValue::from("any JsValue can be logged"); +log!(object); +``` + +Multiple values can also be provided: + +```rust +let object = JsValue::from("Some JsValue"); +log!("literal", object); +``` + +#### `gloo-dialogs` + +`gloo-dialogs` provides wrappers for the following functions: + +- [`alert`](https://developer.mozilla.org/en-US/docs/Web/API/Window/alert) +- [`confirm`](https://developer.mozilla.org/en-US/docs/Web/API/Window/confirm) +- [`prompt`](https://developer.mozilla.org/en-US/docs/Web/API/Window/prompt) + +```rust +alert("Hello World!"); +``` + +```rust +prompt("What do you want to say?"); +``` + + +```rust +confirm("Are you sure?"); +``` + +#### `gloo-render` + +`gloo-render` provides wrapper for +[`requestAnimationFrame`](https://developer.mozilla.org/en-US/docs/Web/API/window/requestAnimationFrame): + +```rust +request_animation_frame(|_| { + // inside animation frame. +}) +``` + +#### `gloo-storage` + +`gloo-storage` provides wrappers for the [Web Storage API](https://developer.mozilla.org/en-US/docs/Web/API/Web_Storage_API). +It can be used to access both local storage and session storage. + +### Other changes + +- We now use GitHub Actions instead of Azure for CI +- READMEs and crate level docs are no longer synced +- This website exists!! + +## Looking for contributors + +Gloo project is in need of contributors. I recently became maintainer of this project, and I'm trying to revive it. +It would be really appreciated if you could contribute or raise awareness about the Gloo project. diff --git a/website/src/pages/__index.md b/website/src/pages/__index.md index f9e75e48..5ad06a85 100644 --- a/website/src/pages/__index.md +++ b/website/src/pages/__index.md @@ -5,7 +5,7 @@ as [API documentation](https://docs.rs/gloo/). ## Gloo Crates -1. [`console-timer`](docs/console) +1. [`console`](docs/console) 2. [`dialog`](docs/dialog) 3. [`event`](docs/event) 4. [`file`](docs/file) @@ -31,7 +31,7 @@ Add a `gloo` dependency to your `Cargo.toml`: ```toml [dependencies] -gloo = "0.2" +gloo = "0.3" ``` ### `src/lib.rs`