1
Fork 0

Update casing in docs for GitHub.

This commit is contained in:
Alex Helfet 2017-12-24 18:58:30 +00:00
parent fea6a96838
commit 700caf31a0
2 changed files with 6 additions and 4 deletions

View file

@ -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)

View file

@ -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