Skip to content

Commit 5b018e2

Browse files
committed
Add more details to project description
1 parent 1aae778 commit 5b018e2

File tree

1 file changed

+5
-5
lines changed

1 file changed

+5
-5
lines changed

README.md

+5-5
Original file line numberDiff line numberDiff line change
@@ -2,18 +2,18 @@
22

33
## What's this?
44

5-
Benchmarks for the Lokole [email data exchange protocol](https://github.com/ascoderu/opwen-cloudserver#data-exchange-format).
5+
This repository contains serialization, compression and encryption benchmarks for the Lokole [email data exchange protocol](https://github.com/ascoderu/opwen-cloudserver#data-exchange-format) with the aim to find the method of encoding our dataset in the smallest possible size to save bandwidth for users of the system.
66

7-
> :bulb: Do you know a compression or serialization that could make our data even smaller? Then open a pull request! :octocat:
7+
> :bulb: Do you know a compression or serialization that could make our data smaller? Then open a pull request! :octocat:
88
99
## Setup
1010

1111
Install the requirements with `pip install -r requirements.txt -r requirements-dev.txt`.
1212

13-
Run the tests with `python3 -m benchmarks.tests` and run the linter with `flake8 benchmarks`.
13+
Run the tests with `python -m benchmarks.tests` and run the linter with `flake8 benchmarks`.
1414

15-
Run the benchmarks via `python3 -u -m benchmarks <emails-zip-url>`.
15+
Run the benchmarks via `python -u -m benchmarks <emails-zip-url>`.
1616

1717
## Results
1818

19-
Benchmark results are kept up to date by Github Actions at [ascoderu/compression-benchmarks](https://ascoderu.ca/compression-benchmarks/).
19+
Benchmark results are kept up to date by [Github Actions](https://github.com/ascoderu/compression-benchmarks/actions?query=workflow%3ACD) at [ascoderu/compression-benchmarks](https://ascoderu.ca/compression-benchmarks/).

0 commit comments

Comments
 (0)