From ee138ce50bd82eda3f5e33cb5718b7431d73bf29 Mon Sep 17 00:00:00 2001 From: urasakikeisuke Date: Mon, 13 May 2024 19:54:04 +0900 Subject: [PATCH] Add badges and table of contents to README.md - Added badges for test, PyPI version, Python version, license, and downloads. - Added a table of contents with links to various sections in the README.md file. Signed-off-by: urasakikeisuke --- README.md | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/README.md b/README.md index a78fbff..202f192 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,26 @@ # pypcd4 +[![Test](https://github.com/MapIV/pypcd4/actions/workflows/test.yaml/badge.svg)](https://github.com/MapIV/pypcd4/actions/workflows/test.yaml) +![PyPI - Version](https://img.shields.io/pypi/v/pypcd4) +![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pypcd4) +![GitHub License](https://img.shields.io/github/license/MapIV/pypcd4) +![PyPI - Downloads](https://img.shields.io/pypi/dm/pypcd4) + +## Table of Contents + +* [Description](#description) +* [Installation](#installation) +* [Usage](#usage) + * [Importing pypcd4](#getting-started) + * [Loading PCD File](#working-with-pcd-files) + * [Converting to NumPy Array](#converting-between-pointcloud-and-numpy-array) + * [Converting to ROS Message](#working-with-ros-pointcloud2-messages) + * [Concatenating PointClouds](#concatenating-two-pointclouds) + * [Filtering PointClouds](#filtering-a-pointcloud) + * [Saving Your Work](#saving-your-work) +* [Contributing](#contributing) +* [License](#license) + ## Description pypcd4 is a modern reimagining of the original [pypcd](https://github.com/dimatura/pypcd) library,