From 700caf31a09214b22d1fd1abcfd9f40373bedca7 Mon Sep 17 00:00:00 2001 From: Alex Helfet Date: Sun, 24 Dec 2017 18:58:30 +0000 Subject: [PATCH] Update casing in docs for `GitHub`. --- README.md | 5 +++-- doc/release.md | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index f20eb9f..64aa4fc 100644 --- a/README.md +++ b/README.md @@ -14,8 +14,9 @@ nightly toolchain), it should also build in embedded projects with ## Development -Source code and issues on Github: -[![Github last commit](https://img.shields.io/github/last-commit/fluffysquirrels/framed-rs.svg)][github] +Source code and issues on GitHub: +[![GitHub last commit](https://img.shields.io/github/last-commit/fluffysquirrels/framed-rs.svg)][github] + [github]: https://github.com/fluffysquirrels/framed-rs CI build on Travis CI: [![Build Status](https://travis-ci.org/fluffysquirrels/framed-rs.svg)](https://travis-ci.org/fluffysquirrels/framed-rs) diff --git a/doc/release.md b/doc/release.md index 11747d4..189ba85 100644 --- a/doc/release.md +++ b/doc/release.md @@ -1,16 +1,17 @@ # Release process +1. Push changes to [GitHub][github]. 1. Check build locally with `bin/build_local`. 1. Check [Travis build][travis]: [![Build Status](https://travis-ci.org/fluffysquirrels/framed-rs.svg)][travis]. [travis]: https://travis-ci.org/fluffysquirrels/framed-rs 1. Increment version number in Cargo.toml (major version if breaking changes). -1. Add a git tag for the new version number. Push it to [github][github]. - [github]: https://github.com/fluffysquirrels/framed-rs +1. Add a git tag for the new version number. Push it to [GitHub][github]. 1. Publish with `bin/publish`. 1. Check new version appears on [![Crate](https://img.shields.io/crates/v/framed.svg)][crates] and [![Documentation](https://docs.rs/framed/badge.svg)][docs] + [github]: https://github.com/fluffysquirrels/framed-rs [crates]: https://crates.io/crates/framed [docs]: https://docs.rs/framed