diff --git a/CHANGELOG.md b/CHANGELOG.md index 5e6247c..7748773 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,12 @@ All notable changes to this project will be documented in this file. +## [1.0.0-beta.3] - 2023-10-13 + +### Documentation + +- Update README with project and badge info + ## [1.0.0-beta.2] - 2023-10-13 ### Features diff --git a/Cargo.lock b/Cargo.lock index 08d2b75..6bc1f10 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -603,7 +603,7 @@ checksum = "9cdc71e17332e86d2e1d38c1f99edcb6288ee11b815fb1a4b049eaa2114d369b" [[package]] name = "lilnouns-click" -version = "1.0.0-beta.2" +version = "1.0.0-beta.3" dependencies = [ "graphql_client", "html-escape", diff --git a/Cargo.toml b/Cargo.toml index d8df714..85810f0 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,6 +1,6 @@ [package] name = "lilnouns-click" -version = "1.0.0-beta.2" +version = "1.0.0-beta.3" authors = ["Milad Nekofar "] edition = "2021" description = "A Nounish URL shortener for LilNouns DAO." diff --git a/README.md b/README.md index 2a3964d..4393185 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,12 @@ -# Nounish Pro +# Lil Nouns Click -## Wrangler +[![GitHub release (latest SemVer including pre-releases)](https://img.shields.io/github/v/release/lilnouns/lilnouns-click?include_prereleases)](https://github.com/lilnouns/lilnouns-click/releases) +[![GitHub Workflow Status (branch)](https://img.shields.io/github/actions/workflow/status/lilnouns/lilnouns-click/build.yml)](https://github.com/lilnouns/lilnouns-click/actions/workflows/build.yml) +[![GitHub](https://img.shields.io/github/license/lilnouns/lilnouns-click)](https://github.com/lilnouns/lilnouns-click/blob/master/LICENSE) +[![X (formerly Twitter) Follow](https://img.shields.io/badge/follow-%40nekofar-ffffff?logo=x&style=flat)](https://x.com/nekofar) +[![Donate](https://img.shields.io/badge/donate-nekofar.crypto-a2b9bc?logo=ko-fi&logoColor=white)](https://ud.me/nekofar.crypto) -Wrangler is used to develop, deploy, and configure your Worker via CLI. -Further documentation for Wrangler can be found [here](https://developers.cloudflare.com/workers/tooling/wrangler). - -## Usage - -With `wrangler`, you can build, test, and deploy your Worker with the following commands: - -```sh -# run your Worker in an ideal development workflow (with a local server, file watcher & more) -$ pnpm run dev - -# deploy your Worker globally to the Cloudflare network (update your wrangler.toml file for configuration) -$ pnpm run deploy -``` - -Read the latest `worker` crate documentation here: https://docs.rs/worker - -## WebAssembly - -All crates and modules used in Rust-based Workers projects have to compile to the `wasm32-unknown-unknown` triple. - -Read more about this on the [`workers-rs`](https://github.com/cloudflare/workers-rs) project README. - -## Issues - -If you have any problems, please open an issue on the project issue tracker on the [this repository](https://github.com/nekofar/lilnouns-click). +> [!WARNING] +> Please note that the project is currently in an experimental phase and it is subject to significant changes as it +> progresses.