Skip to content

Add badges for license, CI, and documentation status in README #24

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 12, 2025
Merged

Add badges for license, CI, and documentation status in README #24

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be9fa17
Add badges for license, CI, and documentation status in README
NuwanJ Sep 12, 2025
9db4da5
Merge branch 'dev' into adding-badges
NuwanJ Sep 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# Robot Library (Python)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![CI](https://github.com/Pera-Swarm/robot-library-python/actions/workflows/ci.yml/badge.svg)](https://github.com/Pera-Swarm/robot-library-python/actions/workflows/ci.yml)
[![Documentation: Publish](https://github.com/Pera-Swarm/robot-library-python/actions/workflows/docs-cd.yml/badge.svg)](https://github.com/Pera-Swarm/robot-library-python/actions/workflows/docs-cd.yml)

A modular Python library for building robot applications. It provides components for motion control, sensors, communications, and indicators over MQTT.

Documentation: the full site is auto-built and deployed to GitHub Pages on pushes to the `dev` branch. Once enabled in the repo settings, it will be available at: `https://pera-swarm.github.io/robot-library-python/`.
Expand Down
Loading