From 6331b5be16c67a368700ca83f5012f489b97ae67 Mon Sep 17 00:00:00 2001
From: Denis Nutiu <denis.nutiu@gmail.com>
Date: Wed, 20 Nov 2024 23:53:55 +0200
Subject: [PATCH] add readme.md

---
 Cargo.lock | 26 +++++++++++++-------------
 Cargo.toml |  2 +-
 readme.md  | 16 ++++++++++++++++
 3 files changed, 30 insertions(+), 14 deletions(-)
 create mode 100644 readme.md

diff --git a/Cargo.lock b/Cargo.lock
index 4729ef6..e681df8 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -85,7 +85,19 @@ source = "registry+https://github.com/rust-lang/crates.io-index"
 checksum = "b048fb63fd8b5923fc5aa7b340d8e156aec7ec02f0c78fa8a6ddc2613f6f71de"
 
 [[package]]
-name = "bme-680-json"
+name = "bme680"
+version = "0.9.0"
+source = "git+https://github.com/dnutiu/bme680-rust.git?branch=v0.9.0#31f3a4c4c0d03e4a7f0da9a898f9d25844894773"
+dependencies = [
+ "anyhow",
+ "bitflags 2.6.0",
+ "embedded-hal",
+ "linux-embedded-hal",
+ "log",
+]
+
+[[package]]
+name = "bme680-json"
 version = "1.0.0"
 dependencies = [
  "anyhow",
@@ -98,18 +110,6 @@ dependencies = [
  "serde_json",
 ]
 
-[[package]]
-name = "bme680"
-version = "0.9.0"
-source = "git+https://github.com/dnutiu/bme680-rust.git?branch=v0.9.0#31f3a4c4c0d03e4a7f0da9a898f9d25844894773"
-dependencies = [
- "anyhow",
- "bitflags 2.6.0",
- "embedded-hal",
- "linux-embedded-hal",
- "log",
-]
-
 [[package]]
 name = "byteorder"
 version = "1.5.0"
diff --git a/Cargo.toml b/Cargo.toml
index 7fb3bc2..1fa8571 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -1,5 +1,5 @@
 [package]
-name = "bme-680-json"
+name = "bme680-json"
 version = "1.0.0"
 edition = "2021"
 
diff --git a/readme.md b/readme.md
new file mode 100644
index 0000000..044aaeb
--- /dev/null
+++ b/readme.md
@@ -0,0 +1,16 @@
+# Bme680 Json
+
+Bme680 Json is a CLI that helps you gather the measurements of the bme-680 sensor and prints them in JSON format.
+
+To install the CLI run:
+
+```bash
+cargo install --git https://github.com/dnutiu/bme-680-json.git
+```
+
+Then run:
+
+```bash
+bme680-json
+{"temperature":32.66,"pressure":622.29,"humidity":100.0,"gas_resistance":802874}
+```
\ No newline at end of file