summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorNick Gerace <nickagerace@gmail.com>2023-06-26 17:08:09 -0400
committerNick Gerace <nickagerace@gmail.com>2023-06-26 17:22:28 -0400
commit8a7674100aacf1c5e9d31ddee6ea5565439ff251 (patch)
tree179508b44c44b62409e69ffd54a55857708c538b
parent3c83e4f1aa0f0436417e4253ff17ed99b60309ac (diff)
downloadgfold-8a7674100aacf1c5e9d31ddee6ea5565439ff251.zip
Publish libgfold for the first time
Signed-off-by: Nick Gerace <nickagerace@gmail.com>
-rw-r--r--Cargo.lock2
-rw-r--r--bin/gfold/Cargo.toml2
-rw-r--r--lib/libgfold/Cargo.toml10
-rw-r--r--lib/libgfold/README.md19
4 files changed, 25 insertions, 8 deletions
diff --git a/Cargo.lock b/Cargo.lock
index e532f84..7de4cd4 100644
--- a/Cargo.lock
+++ b/Cargo.lock
@@ -461,7 +461,7 @@ checksum = "b4668fb0ea861c1df094127ac5f1da3409a82116a4ba74fca2e58ef927159bb3"
[[package]]
name = "libgfold"
-version = "0.1.0"
+version = "0.1.1"
dependencies = [
"anyhow",
"env_logger",
diff --git a/bin/gfold/Cargo.toml b/bin/gfold/Cargo.toml
index 39a8708..65d83bc 100644
--- a/bin/gfold/Cargo.toml
+++ b/bin/gfold/Cargo.toml
@@ -13,7 +13,7 @@ readme = "../../README.md"
repository = "https://github.com/nickgerace/gfold/"
[dependencies]
-libgfold = { path = "../../lib/libgfold" }
+libgfold = { version = "0.1.1", path = "../../lib/libgfold" }
anyhow = { workspace = true }
clap = { workspace = true }
diff --git a/lib/libgfold/Cargo.toml b/lib/libgfold/Cargo.toml
index 95e2952..e8f5b2d 100644
--- a/lib/libgfold/Cargo.toml
+++ b/lib/libgfold/Cargo.toml
@@ -1,17 +1,15 @@
[package]
name = "libgfold"
-version = "0.1.0"
+version = "0.1.1"
edition = "2021"
-# NOTE(nick): Temporary until libgfold is ready for release
-publish = false
-
-# TODO(nick): add categories and description
authors = ["Nick Gerace <nickagerace@gmail.com>"]
+categories = ["development-tools"]
+description = "Provides the ability to find a minimal set of user-relevant information for Git repositories on a local filesystem."
homepage = "https://nickgerace.dev"
keywords = ["git"]
license = "Apache-2.0"
-readme = "../../README.md"
+readme = "README.md"
repository = "https://github.com/nickgerace/gfold/"
[dependencies]
diff --git a/lib/libgfold/README.md b/lib/libgfold/README.md
new file mode 100644
index 0000000..320f912
--- /dev/null
+++ b/lib/libgfold/README.md
@@ -0,0 +1,19 @@
+# libgfold
+
+[![crates.io version](https://img.shields.io/crates/v/libgfold?style=flat-square&logo=rust&color=orange)](https://crates.io/crates/libgfold)
+[![license](https://img.shields.io/github/license/nickgerace/gfold?style=flat-square&logo=apache&color=silver)](../../LICENSE)
+[![build status](https://img.shields.io/github/actions/workflow/status/nickgerace/gfold/ci.yml?branch=main&style=flat-square&logo=github&logoColor=white)](https://github.com/nickgerace/gfold/actions)
+
+**libgfold** provides the ability to find a minimal set of user-relevant information for Git repositories on a local
+filesystem.
+This library powers [**gfold**](https://github.com/nickgerace/gfold).
+
+## Documentation
+
+<!-- You can find the docs on [docs.rs](https://docs.rs/libgfold), but they are a work in progress. -->
+
+View documentation locally with the following command.
+
+```shell
+cargo doc -p libgfold --no-deps --open
+``` \ No newline at end of file