Skip to content

Commit 8fb0e0e

Browse files
committed
v0.1.0 — Initial release
1 parent c8f8cd1 commit 8fb0e0e

File tree

2 files changed

+19
-3
lines changed

2 files changed

+19
-3
lines changed

Cargo.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ description = "Parse & construct GitHub repository URLs & specifiers"
77
authors = ["John Thorvald Wodder II <[email protected]>"]
88
repository = "https://github.com/jwodder/ghrepo-rust"
99
license = "MIT"
10-
keywords = ["GitHub", "URL parsing", "repository"]
10+
keywords = ["GitHub", "URL-parsing", "repository"]
1111
categories = ["command-line-utilities"]
1212
exclude = ["/.*"]
1313

README.md

+18-2
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1-
[![Project Status: WIPInitial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
1+
[![Project Status: ActiveThe project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
22
[![CI Status](https://github.com/jwodder/ghrepo-rust/actions/workflows/test.yml/badge.svg)](https://github.com/jwodder/ghrepo-rust/actions/workflows/test.yml)
33
[![codecov.io](https://codecov.io/gh/jwodder/ghrepo-rust/branch/master/graph/badge.svg)](https://codecov.io/gh/jwodder/ghrepo-rust)
44
[![MIT License](https://img.shields.io/github/license/jwodder/ghrepo.svg)](https://opensource.org/licenses/MIT)
55

6-
[GitHub](https://github.com/jwodder/ghrepo-rust) <!-- | [crates.io](https://crates.io/crates/ghrepo) --> <!-- | [Documentation](https://docs.rs/ghrepo) --> | [Issues](https://github.com/jwodder/ghrepo-rust/issues) <!-- | [Changelog](https://github.com/jwodder/ghrepo-rust/blob/master/CHANGELOG.md) -->
6+
[GitHub](https://github.com/jwodder/ghrepo-rust) | [crates.io](https://crates.io/crates/ghrepo) | [Documentation](https://docs.rs/ghrepo) | [Issues](https://github.com/jwodder/ghrepo-rust/issues)
77

88
`ghrepo` extracts a GitHub repository's owner & name from various GitHub URL
99
formats (or just from a string of the form `OWNER/REPONAME` or `REPONAME`), and
@@ -12,6 +12,22 @@ possible URLs. Also included is a struct for performing a couple useful
1212
inspections on local Git repositories, including determining the corresponding
1313
GitHub owner & repository name.
1414

15+
Installation
16+
============
17+
18+
`ghrepo` requires version 1.60 of Rust or higher. To use the `ghrepo` library
19+
in your Cargo project, add the following to your `Cargo.toml`:
20+
21+
```toml
22+
[dependencies]
23+
ghrepo = "0.1.0"
24+
```
25+
26+
To install the `ghrepo` command on your system, use `cargo install`:
27+
28+
cargo install ghrepo
29+
30+
1531
Example
1632
=======
1733

0 commit comments

Comments
 (0)