From ede3932d5abde50e7374fa9b56ffe36fd7459627 Mon Sep 17 00:00:00 2001
From: Nuno David <ndavidq0@gmail.com>
Date: Sat, 9 Sep 2023 22:36:46 +0100
Subject: [PATCH] Chore: Prepare for crates.io

---
 .github/README.md              | 13 ++++++++++---
 .github/workflows/release.yaml |  4 ++--
 Cargo.toml                     |  5 +++++
 3 files changed, 17 insertions(+), 5 deletions(-)

diff --git a/.github/README.md b/.github/README.md
index 516e68b..ed3e167 100644
--- a/.github/README.md
+++ b/.github/README.md
@@ -1,4 +1,4 @@
-# ncube - Generalized Hypercube Visualizer
+# ncube - A Generalized Hypercube Visualizer
 
 `ncube` allows you to visualize hypercubes of arbitrary dimensions.
 It works by rotating the hyperdimensional vertices and applying a chain of perspective projections to them until the 3rd dimension is reached.
@@ -15,15 +15,22 @@ Aditional features:
 ### Download the pre-built binaries
 Pre-built binaries for Windows, Linux, MacOS can be found in the [releases](https://github.com/ndavd/ncube/releases) page.
 
+### Install from crates.io
+Install [cargo](https://doc.rust-lang.org/stable/cargo/) and run the command:
+```
+cargo install ncube
+```
+
 ### Install from source
-You need to setup Rust ([cargo](https://doc.rust-lang.org/stable/cargo/)) to build this project from source.
+You need to setup Rust (install [cargo](https://doc.rust-lang.org/stable/cargo/)) to build this project from source.
 After that, simply clone clone the repository and run the install command:
 ```
 git clone https://github.com/ndavd/ncube
 cd ncube
 cargo install --path .
 ```
-To uninstall, simply run:
+
+### Uninstall
 ```
 cargo uninstall ncube
 ```
diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml
index 9d2f033..02dbd00 100644
--- a/.github/workflows/release.yaml
+++ b/.github/workflows/release.yaml
@@ -32,9 +32,9 @@ jobs:
           sudo apt-get update; sudo apt-get install pkg-config libx11-dev libasound2-dev libudev-dev libxcb-render0-dev libxcb-shape0-dev libxcb-xfixes0-dev
 
       - name: Publish to crates.io
-        run: cargo publish --token ${CRATES_TOKEN}
+        run: cargo publish
         env:
-          CRATES_TOKEN: ${{ secrets.CRATES_TOKEN }}
+          CARGO_REGISTRY_TOKEN: ${{ secrets.CARGO_REGISTRY_TOKEN }}
 
   # Linux
   release-linux:
diff --git a/Cargo.toml b/Cargo.toml
index 41c6ad2..c5831ab 100644
--- a/Cargo.toml
+++ b/Cargo.toml
@@ -5,6 +5,11 @@ edition = "2021"
 authors = ["Nuno David <email@ndavd.com>"]
 license = "MIT"
 description = "Generalized hypercube visualizer"
+readme = ".github/README.md"
+repository = "https://github.com/ndavd/ncube"
+exclude = [".github/demo.gif"]
+keywords = ["simulation", "hypercube", "bevy", "mathematics", "tesseract"]
+categories = ["simulation", "mathematics", "visualization", "graphics"]
 
 [dependencies]
 bevy = "0.11.0"