Skip to content

Commit

Permalink
readme updated
Browse files Browse the repository at this point in the history
  • Loading branch information
Aviksaikat committed Nov 10, 2023
1 parent 9689a9b commit 2d9bfda
Showing 1 changed file with 21 additions and 19 deletions.
40 changes: 21 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,21 +5,23 @@

<p align="center">

<img src="https://img.shields.io/github/stars/aviksaikat/swarm-cid-py.svg">
<img src="https://img.shields.io/github/forks/aviksaikat/swarm-cid-py.svg">
<img src="https://img.shields.io/github/issues/aviksaikat/swarm-cid-py.svg">

<img src="https://img.shields.io/badge/python-3670A0?style=for-the-badge&logo=python&logoColor=ffffff" alt="Python" />
<img src="https://img.shields.io/badge/Poetry-60A5FA.svg?style=for-the-badge&logo=Poetry&logoColor=white" alt="Poetry" />
<img src="https://img.shields.io/badge/Poetry-60A5FA.svg?style=for-the-badge&logo=Poetry&logoColor=white" alt="Poetry" />

<img src="https://img.shields.io/badge/GitHub%20Actions-2088FF.svg?style=for-the-badge&logo=GitHub-Actions&logoColor=white" alt="GitHub%20Actions" />
<img src="https://img.shields.io/badge/Pytest-0A9EDC.svg?style=for-the-badge&logo=Pytest&logoColor=white" alt="Pytest" />
<img src="https://img.shields.io/badge/Pytest-0A9EDC.svg?style=for-the-badge&logo=Pytest&logoColor=white" alt="Pytest" />
</p>

<p>
<img src ="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black"/>
<img src ="https://img.shields.io/badge/imports-isort-17DE93.svg" alt="imports: isort"/>
<img src = "https://www.mypy-lang.org/static/mypy_badge.svg">
<p align="center">
<img src="https://img.shields.io/github/stars/aviksaikat/swarm-cid-py.svg">
<img src="https://img.shields.io/github/forks/aviksaikat/swarm-cid-py.svg">
<img src="https://img.shields.io/github/issues/aviksaikat/swarm-cid-py.svg">
</p>

<p align="center">
<img src ="https://img.shields.io/badge/code%20style-black-000000.svg" alt="Code style: black"/>
<img src ="https://img.shields.io/badge/imports-isort-17DE93.svg" alt="imports: isort"/>
<img src = "https://www.mypy-lang.org/static/mypy_badge.svg">
</p>

<img src="https://img.shields.io/github/license/Aviksaikat/swarm-cid-py?style=for-the-badge&color=DEDE17" alt="GitHub license" />
Expand All @@ -28,7 +30,7 @@
<img src="https://img.shields.io/github/languages/top/Aviksaikat/swarm-cid-py?style=for-the-badge&color=DEDE17" alt="GitHub top language" />
</div>

---
______________________________________________________________________

## 📖 Table of Contents

Expand All @@ -41,7 +43,7 @@
- [🤝 Contributing](#-contributing)
- [📄 License](#-license)

---
______________________________________________________________________

## 📍 Api

Expand Down Expand Up @@ -97,7 +99,7 @@ Encodes a manifest reference string into a CID.

- reference: The manifest reference string to encode.

---
______________________________________________________________________

## 🚀 Getting Started

Expand All @@ -107,15 +109,15 @@ Encodes a manifest reference string into a CID.
py-multiformats-cid
```

---
______________________________________________________________________

### 🔧 Installation

```sh
pip install swarm_cid_py
```

---
______________________________________________________________________

### 🤖 Running swarm-cid-py

Expand All @@ -131,15 +133,15 @@ bah5acgzajskjpfgwc4ry3euo6hofitxaps647vvzi3ssal5anrgtecenpzuq
'4c949794d617238d928ef1dc544ee07cbdcfd6b946e5202fa06c4d32088d7e69', 'type': 'manifest'}
```

---
______________________________________________________________________

### 🧪 Tests

```sh
pytest tests/test_swarm_cid.py
```

---
______________________________________________________________________

## 🤝 Contributing

Expand Down Expand Up @@ -178,12 +180,12 @@ Once your PR is reviewed and approved, it will be merged into the main branch.

</details>

---
______________________________________________________________________

## 📄 License

This project is protected under the [BSD-3-Clause](./LICENSE) License.

[**Return**](#Top)

---
______________________________________________________________________

0 comments on commit 2d9bfda

Please sign in to comment.