Skip to content

Commit

Permalink
docs: add github badges for package
Browse files Browse the repository at this point in the history
  • Loading branch information
Ja7ad committed Jan 21, 2025
1 parent b464729 commit 7069238
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 9 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,8 @@
# 🚀 algo: A Collection of High-Performance Algorithms in Golang
# algo: A Collection of High-Performance Algorithms in Golang

[![Go Reference](https://pkg.go.dev/badge/github.com/Ja7ad/algo.svg)](https://pkg.go.dev/github.com/Ja7ad/algo)
[![codecov](https://codecov.io/gh/Ja7ad/algo/graph/badge.svg?token=9fLKrkUviU)](https://codecov.io/gh/Ja7ad/algo)
[![Go Report Card](https://goreportcard.com/badge/github.com/Ja7ad/algo)](https://goreportcard.com/report/github.com/Ja7ad/algo)

**`algo`** is a Golang library featuring a variety of **efficient** and **well-optimized** algorithms designed for diverse **problem-solving needs**.

Expand All @@ -16,7 +20,13 @@
| [Random Weighted Selection](./rws/README.md) | Selects items randomly based on assigned weights. Useful in load balancing, gaming, and AI. |


## 🚀 Usage Example
## 🚀 Installation >= go 1.19

```shell
go get -u github.com/Ja7ad/algo
```

## ✅ Usage Example

Here’s how you can use the **Random Weighted Selection** algorithm:

Expand Down
7 changes: 0 additions & 7 deletions rws/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,10 +115,3 @@ $$ \text{Weights} = [3, 1, 6] $$
- If $0 \leq R < 3$ → Select **A**
- If $3 \leq R < 4$ → Select **B**
- If $4 \leq R < 10$ → Select **C**


## 📝 **License**
This project is licensed under the **MIT License**.

## 🤝 **Contributions**
Feel free to **fork** this repository and submit **pull requests**. Any contributions to improve performance or add new selection methods are welcome! 🚀

0 comments on commit 7069238

Please sign in to comment.