docs(record): add README.md

This is generated via `cargo readme`.
arxanas · Apr 11, 2022 · f6b4df2 · f6b4df2
1 parent 352e8e9
commit f6b4df2
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 5 deletions.
diff --git a/git-record/Cargo.toml b/git-record/Cargo.toml
@@ -11,9 +11,6 @@ version = "0.1.0"
 
 # See more keys and their definitions at https://doc.rust-lang.org/cargo/reference/manifest.html
 
-[lib]
-name = "git_record"
-
 [dependencies]
 cursive = { version = "0.17.0", default-features = false, features = [
   "crossterm-backend",

diff --git a/git-record/README.md b/git-record/README.md
@@ -0,0 +1,14 @@
+# git-record
+
+Supporting library for
+[git-branchless](https://github.com/arxanas/git-branchless).
+
+This is a UI component to interactively select changes to include in a
+commit. It's meant to be embedded in source control tooling.
+
+You can think of this as an interactive replacement for `git add -p`, or a
+reimplementation of `hg crecord`. Given a set of changes made by the user,
+this component presents them to the user and lets them select which of those
+changes should be staged for commit.
+
+License: MIT OR Apache-2.0
diff --git a/git-record/src/lib.rs b/git-record/src/lib.rs
@@ -1,5 +1,8 @@
-//! UI component to interactively select changes to include in a commit. This
-//! component is meant to be embedded in source control tooling.
+//! Supporting library for
+//! [git-branchless](https://github.com/arxanas/git-branchless).
+//!
+//! This is a UI component to interactively select changes to include in a
+//! commit. It's meant to be embedded in source control tooling.
 //!
 //! You can think of this as an interactive replacement for `git add -p`, or a
 //! reimplementation of `hg crecord`. Given a set of changes made by the user,