Skip to content

Commit

Permalink
Improve readme badges (rerun-io#1307)
Browse files Browse the repository at this point in the history
* Fix RELEASES.md

* Add badges for pypi and crates.io, and center the badges

* Center badges and fix links
  • Loading branch information
emilk authored Feb 14, 2023
1 parent 21bbf03 commit 8f27cbe
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 13 deletions.
12 changes: 7 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
</a>
</h1>

[![CI (Python)](https://github.com/rerun-io/rerun/actions/workflows/python.yml/badge.svg?branch=main)](https://github.com/rerun-io/rerun/actions/workflows/python.yml)
[![CI (Rust)](https://github.com/rerun-io/rerun/actions/workflows/rust.yml/badge.svg?branch=main)](https://github.com/rerun-io/rerun/actions/workflows/rust.yml)
[![MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/rerun-io/rerun/blob/master/LICENSE-MIT)
[![Apache](https://img.shields.io/badge/license-Apache-blue.svg)](https://github.com/rerun-io/rerun/blob/master/LICENSE-APACHE)
[![Discord](https://img.shields.io/discord/1062300748202921994?label=Rerun%20Discord)](https://discord.gg/Gcm8BbTaAj)
<h1 align="center">
<a href="https://pypi.org/project/rerun-sdk/"> <img alt="PyPi" src="https://img.shields.io/pypi/v/rerun-sdk.svg"> </a>
<a href="https://crates.io/crates/rerun"> <img alt="crates.io" src="https://img.shields.io/crates/v/rerun.svg"> </a>
<a href="https://github.com/rerun-io/rerun/blob/master/LICENSE-MIT"> <img alt="MIT" src="https://img.shields.io/badge/license-MIT-blue.svg"> </a>
<a href="https://github.com/rerun-io/rerun/blob/master/LICENSE-APACHE"> <img alt="Apache" src="https://img.shields.io/badge/license-Apache-blue.svg"> </a>
<a href="https://discord.gg/Gcm8BbTaAj"> <img alt="Rerun Discord" src="https://img.shields.io/discord/1062300748202921994?label=Rerun%20Discord"> </a>
</h1>

# Rerun: Visualization infrastructure for computer vision.

Expand Down
6 changes: 3 additions & 3 deletions RELEASES.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,11 +58,11 @@ Copy this checklist to the the PR description, go through it from top to bottom,
* [ ] Get the PR reviewed
* [ ] Check that CI is green
* [ ] Publish new Rust crates
* [ ] `git tag -a v0.x.y -m 'Release 0.x.y - summary'
* [ ] Merge PR
* [ ] `git tag -a v0.x.y -m 'Release 0.x.y - summary'`
* [ ] `git push --tags`
* [ ] Unless this is an alpha release:
* `git pull --tags && git tag -d latest && git tag -a latest -m 'Latest release' && git push origin latest --force`
* [ ] Merge PR
* `git pull --tags && git tag -d latest && git tag -a latest -m 'Latest release' && git push --tags origin latest --force`
* [ ] Wait for CI to build release artifacts and publish them on GitHub and PyPI. Verify this at https://github.com/rerun-io/rerun/releases/new.
* [ ] Wait for documentation to build: https://docs.rs/releases/queue
* [ ] Post on:
Expand Down
12 changes: 7 additions & 5 deletions crates/rerun/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,13 @@
</a>
</h1>

[![Latest version](https://img.shields.io/crates/v/re_ws_comms.svg)](https://crates.io/crates/rerun)
[![Documentation](https://docs.rs/re_ws_comms/badge.svg)](https://docs.rs/rerun)
![MIT](https://img.shields.io/badge/license-MIT-blue.svg)
![Apache](https://img.shields.io/badge/license-Apache-blue.svg)
[![Discord](https://img.shields.io/discord/1062300748202921994?label=Rerun%20Discord)](https://discord.gg/Gcm8BbTaAj)
<h1 align="center">
<a href="https://crates.io/crates/rerun"> <img alt="Latest version" src="https://img.shields.io/crates/v/rerun.svg"> </a>
<a href="https://docs.rs/rerun"> <img alt="Documentation" src="https://docs.rs/rerun/badge.svg"> </a>
<a href="https://github.com/rerun-io/rerun/blob/master/LICENSE-MIT"> <img alt="MIT" src="https://img.shields.io/badge/license-MIT-blue.svg"> </a>
<a href="https://github.com/rerun-io/rerun/blob/master/LICENSE-APACHE"> <img alt="Apache" src="https://img.shields.io/badge/license-Apache-blue.svg"> </a>
<a href="https://discord.gg/Gcm8BbTaAj"> <img alt="Rerun Discord" src="https://img.shields.io/discord/1062300748202921994?label=Rerun%20Discord"> </a>
</h1>

# Rerun Rust logging SDK
Rerun is an SDK for logging computer vision and robotics data paired with a visualizer for exploring that data over time. It lets you debug and understand the internal state and data of your systems with minimal code.
Expand Down

0 comments on commit 8f27cbe

Please sign in to comment.