Skip to content

Commit

Permalink
Merge pull request #149 from hashcloak/update-readme
Browse files Browse the repository at this point in the history
Update README.md
  • Loading branch information
sc0Vu authored Aug 9, 2022
2 parents e8b2c60 + a834e2c commit 6532547
Show file tree
Hide file tree
Showing 5 changed files with 21 additions and 17 deletions.
19 changes: 13 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,25 @@
# Meson
[![Build Status](https://travis-ci.com/hashcloak/Meson.svg?branch=master)](https://travis-ci.com/hashcloak/Meson)
[![Integration](https://github.com/hashcloak/Meson/actions/workflows/integration.yml/badge.svg)](https://github.com/hashcloak/Meson/actions/workflows/integration.yml)
[![Plugin](https://github.com/hashcloak/Meson/actions/workflows/plugin.yml/badge.svg)](https://github.com/hashcloak/Meson/actions/workflows/plugin.yml)
[![Katzenmint](https://github.com/hashcloak/Meson/actions/workflows/katzenmint.yml/badge.svg)](https://github.com/hashcloak/Meson/actions/workflows/katzenmint.yml)
[![Server](https://github.com/hashcloak/Meson/actions/workflows/server.yml/badge.svg)](https://github.com/hashcloak/Meson/actions/workflows/server.yml)
[![Client](https://github.com/hashcloak/Meson/actions/workflows/client.yml/badge.svg)](https://github.com/hashcloak/Meson/actions/workflows/client.yml)
[![pages-build-deployment](https://github.com/hashcloak/Meson/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/hashcloak/Meson/actions/workflows/pages/pages-build-deployment)

This is the main repository related to the Meson project.
Meson is a mixnet for cryptocurrency transactions. Meson is based on the [Katzenpost software project](https://katzenpost.mixnetworks.org/).

We have forked important parts of the Katzenpost mix network project in order to better compliment our upcoming changes and our cryptocurrency transaction usecase. Here are the places in which you can expect activity related to Meson's ongoing development:
- [Katzenmint](https://github.com/hashcloak/katzenmint-pki): An in-progress new PKI design for mix networks
- [Meson-server](https://github.com/hashcloak/Meson-server): Forked from the original Katzenpost server in which we make changes better suited for our Katzenmint PKI design and upcoming changes to how nodes (providers and mixes) will work in Meson.
- [Meson-client](https://github.com/hashcloak/Meson-client): Forked from the original Katzenpost client in which we make changes better suited for our Katzenmint PKI design and upcoming changes to how clients will work in Meson.
- [Katzenmint](https://github.com/hashcloak/Meson/tree/master/katzenmint): An in-progress new PKI design for mix networks
- [Meson-server](https://github.com/hashcloak/Meson/tree/master/server): Forked from the original Katzenpost server in which we make changes better suited for our Katzenmint PKI design and upcoming changes to how nodes (providers and mixes) will work in Meson.
- [Meson-client](https://github.com/hashcloak/Meson/tree/master/client) : Forked from the original Katzenpost client in which we make changes better suited for our Katzenmint PKI design and upcoming changes to how clients will work in Meson.


## Docs
TODO

Plesase go to [docs.mesonmix.net](https://docs.mesonmix.net)

## Usage

TODO
Plesase go to [docs.mesonmix.net/docs/](https://docs.mesonmix.net/docs/)

2 changes: 1 addition & 1 deletion client/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Meson-client
[![Go](https://github.com/hashcloak/Meson/client/actions/workflows/go.yml/badge.svg)](https://github.com/hashcloak/Meson/client/actions/workflows/go.yml)
[![Client](https://github.com/hashcloak/Meson/actions/workflows/client.yml/badge.svg)](https://github.com/hashcloak/Meson/actions/workflows/client.yml)

A simple client for use with the Meson mixnet software

Expand Down
10 changes: 4 additions & 6 deletions katzenmint/README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# katzenmint-pki
[![Go](https://github.com/hashcloak/Meson/actions/workflows/go.yml/badge.svg)](https://github.com/hashcloak/Meson/actions/workflows/go.yml)
[![Katzenmint](https://github.com/hashcloak/Meson/actions/workflows/katzenmint.yml/badge.svg)](https://github.com/hashcloak/Meson/actions/workflows/katzenmint.yml)

A BFT PKI for the Katzenpost Authority PKI System using Tendermint

Expand All @@ -20,8 +20,6 @@ $ cd tendermint
$ git checkout v0.34.6
$ make install
```
2. `TMHOME=`pwd`/chain tendermint init`
3. `make build`
4. `./katzenmint -config ./chain/config/config.toml`
5. `curl -s 'localhost:26657/broadcast_tx_commit?tx="tendermint=rocks"'`
6. `curl -s 'localhost:26657/abci_query?data="tendermint"'`
2. Initialize the identity credential identity `TMHOME=`pwd`/chain tendermint init`
3. Build katzenmint `make build`
4. Execute `./katzenmint -config ./chain/config/config.toml`
3 changes: 1 addition & 2 deletions plugin/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# Meson-plugin

[![Go](https://github.com/hashcloak/Meson-plugin/actions/workflows/go.yml/badge.svg)](https://github.com/hashcloak/Meson-plugin/actions/workflows/go.yml)
[![Plugin](https://github.com/hashcloak/Meson/actions/workflows/plugin.yml/badge.svg)](https://github.com/hashcloak/Meson/actions/workflows/plugin.yml)

A Library for adding cryptocurrencies to Meson mixnet.

Expand Down
4 changes: 2 additions & 2 deletions server/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

Katzenpost Mix Server
=====================
.. image:: https://github.com/hashcloak/Meson/server/actions/workflows/go.yml/badge.svg
:target: https://github.com/hashcloak/Meson/server/actions/workflows/go.yml
.. image:: https://github.com/hashcloak/Meson/actions/workflows/server.yml/badge.svg
:target: https://github.com/hashcloak/Meson/actions/workflows/server.yml

.. image:: https://godoc.org/github.com/hashcloak/Meson/server?status.svg
:target: https://godoc.org/github.com/hashcloak/Meson/server
Expand Down

0 comments on commit 6532547

Please sign in to comment.