Skip to content
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.

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

chore: minor cleanup readme #80

Merged
merged 1 commit into from
Jul 14, 2024
Merged
Changes from all commits
Commits
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
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
![ci](https://github.com/six78/2-story-points-cli/actions/workflows/ci.yml/badge.svg) [![Maintainability](https://api.codeclimate.com/v1/badges/7159536b897586bb0137/maintainability)](https://codeclimate.com/github/six78/2-story-points-cli/maintainability) [![Test Coverage](https://api.codeclimate.com/v1/badges/7159536b897586bb0137/test_coverage)](https://codeclimate.com/github/six78/2-story-points-cli/test_coverage)
![ci](https://github.com/six78/2-story-points-cli/actions/workflows/ci.yml/badge.svg)
[![Maintainability](https://api.codeclimate.com/v1/badges/7159536b897586bb0137/maintainability)](https://codeclimate.com/github/six78/2-story-points-cli/maintainability)
[![Test Coverage](https://api.codeclimate.com/v1/badges/7159536b897586bb0137/test_coverage)](https://codeclimate.com/github/six78/2-story-points-cli/test_coverage)

# Lock, Stock and Two Story Points

♦️️ Decentralized \
♠️ Poker Planning \
♥️ Console Application
### Decentralized poker planning in terminal

<p align="center">
<img width="800" src="docs/demo.gif">
<p align="left">
<img height="450" src="docs/demo.gif">
</p>

[//]: # (Fancy a web version? -> https://six78.github.io/2-story-points )

# Description

- This is a CLI app for poker planning
- We use [Waku](https://waku.org) for players communication
- We use [Waku](https://waku.org) for decantralized players communication
- Messages are end-to-end encrypted, the key is shared elsewhere as part of the room id

[//]: # (# Get it)
Expand All @@ -34,4 +34,4 @@ Or just run the code with a shadow build:
make run
```

Now share your room id with friends and start estimating your issues!
Now share your room id with friends and start estimating your issues!
Loading