Merge pull request #62 from geniusyield/61-readme-add-badges

README: add badges #61

CONTRIBUTING.md

@@ -0,0 +1,36 @@
+# Contributing to the Market Maker
+
+Welcome! We're happy to have you join our community and contribute to this project. To
+learn more about the MM, check out the [README](./README.md) and [GY whitepaper](https://www.geniusyield.co/whitepaper.pdf?lng=en).
+
+## Opening Issues
+
+Use an [existing template](https://github.com/geniusyield/market-maker/issues/new/choose) to:
+- Report a bug
+- Update the docs
+- Request a new feature
+
+Accompany your issue with one or more of the following labels:
+- `bug`
+- `dependencies`
+- `documentation`
+- `duplicate`
+- `github actions`
+- `good first issue`
+- `haskell`
+- `help wanted`
+- `vulnerability`
+- `wont fix`
+
+## Opening Pull Requests
+After opening a pull request, please take the following steps:
+- Ensure your PR has one or more corresponding issues (see above)
+- [Link your PR](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) to those issues
+- Check the [build status](https://github.com/geniusyield/market-maker/actions/new) of your PR
+- Wait for a review and/or approval from one of the code owners
+- Merge and celebrate!
+
+The team will do their best to help you get your PRs across the finish line!
+
+## Discussions
+Feel free to participate in [discussions](https://github.com/geniusyield/market-maker/discussions) with the team and community!

README.md

@@ -1,5 +1,30 @@
 # Market maker bot
 
+<p align="center">
+  <a href="https://github.com/geniusyield/market-maker/actions?query=branch%3Amain">
+    <img src="https://img.shields.io/github/actions/workflow/status/geniusyield/market-maker/build.yml?style=flat-square&branch=main&label=Build" />
+  </a>
+  <a href="https://www.haskell.org/">
+    <img alt="GitHub top language" src="https://img.shields.io/github/languages/top/geniusyield/market-maker">
+  </a>
+  <a href="https://github.com/geniusyield/market-maker/commits/main">
+    <img src="https://img.shields.io/github/commit-activity/m/geniusyield/market-maker?style=flat-square&label=Commit%20Activity" />
+  </a>
+  <a href="https://github.com/geniusyield/market-maker/blob/main/LICENSE">
+    <img src="https://img.shields.io/github/license/geniusyield/market-maker?style=flat-square&label=Licence" />
+  </a>
+  <a href="./CONTRIBUTING.md">
+    <img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square" />
+  </a>
+  <a href="https://twitter.com/GeniusyieldO">
+    <img src="https://img.shields.io/badge/-%40GeniusYieldO-F3F1EF?style=flat-square&logo=twitter&logoColor=1D9BF0" />
+  </a>
+  <a href="https://discord.gg/TNHf4fs626">
+    <img src="https://img.shields.io/badge/-Discord-414EEC?style=flat-square&logo=discord&logoColor=white" />
+  </a>
+</p>
+
+
 > [!WARNING]
 > Market making is a risky activity and running this bot can lead to loss of funds.