Skip to content
This repository has been archived by the owner on Aug 9, 2022. It is now read-only.

Commit

Permalink
Merge pull request #22 from epage/name
Browse files Browse the repository at this point in the history
fix: Rename
  • Loading branch information
epage authored Jan 10, 2022
2 parents 5d29f31 + c2830b1 commit ed887af
Show file tree
Hide file tree
Showing 11 changed files with 25 additions and 25 deletions.
2 changes: 1 addition & 1 deletion .github/settings.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

repository:
description: Interact with the crate's API
homepage: docs.rs/cargo-api
homepage: docs.rs/cargo-crate-api
topics: rust cargo semver
has_issues: true
has_projects: false
Expand Down
2 changes: 1 addition & 1 deletion Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# cargo-api
# cargo-crate-api

> Interact with the crate's API
[![Documentation](https://img.shields.io/badge/docs-master-blue.svg)][Documentation]
![License](https://img.shields.io/crates/l/cargo-api.svg)
[![Crates Status](https://img.shields.io/crates/v/cargo-api.svg)](https://crates.io/crates/cargo-api)
![License](https://img.shields.io/crates/l/cargo-crate-api.svg)
[![Crates Status](https://img.shields.io/crates/v/cargo-crate-api.svg)](https://crates.io/crates/cargo-crate-api)

## Documentation

Expand All @@ -17,25 +17,25 @@

## Install

[Download](https://github.com/crate-ci/cargo-api/releases) a pre-built binary
[Download](https://github.com/crate-ci/cargo-crate-api/releases) a pre-built binary
(installable via [gh-install](https://github.com/crate-ci/gh-install)).

Or use rust to install:
```bash
cargo install cargo-api
cargo install cargo-crate-api
```

## Getting Started

To diff your crate against the last tag, run
```bash
$ cargo api --diff
$ cargo crate-api --diff
```
*(choose the git reference with `--git <REF>`)*

To help get started writing your `CHANGELOG.md`, run:
```bash
$ cargo api --diff --format md
$ cargo crate-api --diff --format md
```

## License
Expand All @@ -54,5 +54,5 @@ submitted for inclusion in the work by you, as defined in the Apache-2.0
license, shall be dual licensed as above, without any additional terms or
conditions.

[Crates.io]: https://crates.io/crates/cargo-api
[Crates.io]: https://crates.io/crates/cargo-crate-api
[Documentation]: https://docs.rs/crate-api
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
[package]
name = "cargo-api"
name = "cargo-crate-api"
description = "Interact with the crate's API"
version = "0.0.1"
license = "MIT OR Apache-2.0"
repository = "https://github.com/crate-ci/cargo-api.git"
homepage = "https://github.com/crate-ci/cargo-api"
documentation = "https://github.com/crate-ci/cargo-api"
repository = "https://github.com/crate-ci/cargo-crate-api.git"
homepage = "https://github.com/crate-ci/cargo-crate-api"
documentation = "https://github.com/crate-ci/cargo-crate-api"
categories = ["development-tools::cargo-plugins"]
keywords = ["cargo"]
edition = "2021"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ use crate::report::Source;
global_setting = concolor_clap::color_choice(),
)]
pub enum Command {
Api(Api),
CrateApi(Api),
}

#[derive(structopt::StructOpt)]
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ fn main() {

fn run() -> proc_exit::ExitResult {
// clap2's `get_matches` uses Failure rather than Unknown, so bypass it for `get_matches_safe`.
let args::Command::Api(args) = match args::Command::from_args_safe() {
let args::Command::CrateApi(args) = match args::Command::from_args_safe() {
Ok(args) => args,
Err(e) if e.use_stderr() => {
return Err(proc_exit::Code::UNKNOWN.with_message(e));
Expand Down
File renamed without changes.
4 changes: 2 additions & 2 deletions crates/crate-api/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,8 @@ name = "crate-api"
description = "Interact with the crate's API"
version = "0.0.1"
license = "MIT OR Apache-2.0"
repository = "https://github.com/crate-ci/cargo-api.git"
homepage = "https://github.com/crate-ci/cargo-api"
repository = "https://github.com/crate-ci/cargo-crate-api.git"
homepage = "https://github.com/crate-ci/cargo-crate-api"
documentation = "https://docs.rs/crate-api"
categories = ["development-tools::cargo-plugins"]
keywords = ["cargo"]
Expand Down
4 changes: 2 additions & 2 deletions crates/rustdoc-json-types-fork/Cargo.toml
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@ name = "rustdoc-json-types-fork"
description = "Interact with the crate's API"
version = "0.0.1"
license = "MIT OR Apache-2.0"
repository = "https://github.com/crate-ci/cargo-api.git"
homepage = "https://github.com/crate-ci/cargo-api"
repository = "https://github.com/crate-ci/cargo-crate-api.git"
homepage = "https://github.com/crate-ci/cargo-crate-api"
documentation = "http://docs.rs/rustdoc-json-types-fork/"
categories = ["development-tools::cargo-plugins"]
keywords = ["cargo"]
Expand Down
10 changes: 5 additions & 5 deletions docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ resulting output with [`syn`](docs.rs/syn):

There is a branch to switch to rustc. This seems like it'd make fairly similar to `semverer`.

## So how is `cargo-api` different?
## So how is `cargo-crate-api` different?

`cargo-api` started in a
`cargo-crate-api` started in a
[conversation with cargo-breaking authors](https://github.com/iomentum/cargo-breaking/issues/40)
on alternative approaches. The idea of building on top of `rustdoc -wjson`
came up. `cargo-api` started as a proof-of-concept for the idea. Further
came up. `cargo-crate-api` started as a proof-of-concept for the idea. Further
collaboration is still being determined.

Highlights:
Expand All @@ -35,7 +35,7 @@ Highlights:
## Why not report back a suggested version?

`cargo-breaking` can output what version to bump to.
[For now](https://github.com/epage/cargo-api/issues/14) we forego this out of
concern for people exclusively relying on `cargo-api` to determine whether
[For now](https://github.com/epage/cargo-crate-api/issues/14) we forego this out of
concern for people exclusively relying on `cargo-crate-api` to determine whether
there are breaking changes, rather than using it as a safety to catch
unexpected breaking changes.

0 comments on commit ed887af

Please sign in to comment.