Skip to content

Commit

Permalink
Merge branch 'develop' of github.com:muflihun/mine into develop
Browse files Browse the repository at this point in the history
  • Loading branch information
abumq committed Mar 8, 2018
2 parents a7c5d72 + 37dfb16 commit cf12d82
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 4 deletions.
17 changes: 15 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,25 @@ Mine is fast, memory-efficient, single-header minimal cryptography implementatio
# Overview
It all started with [ripe](https://github.com/muflihun/ripe) that depends on third-party library (initially OpenSSL then Crypto++) linked statically. However after deploying [residue](https://github.com/muflihun/residue) with ripe to older distributions of linux, we learnt that portability is an issue for ripe as _minimal_ library (because of it's dependencies). So we started to implement standards forming _Mine_.

We are very careful with our implementations and have more than 50 [test cases](/test/) in-place.
We are very careful with our implementations and have over 50 [test cases](/test/) in-place.

# Installation
# Installation (API)
Simply copy `mine.h` and `mine.cc` from [`package/`](/package/) directory to your project or your local machine.

Alternatively, feel free to link it as shared or static library (you will need to compile yourself)

# Installation (CLI Tool)
You can either download binary for your platform via [releases](https://github.com/muflihun/mine/releases) page or using NPM

```
npm install -g mine-linux@latest
sudo ln -s `which mine-linux` /usr/local/bin/mine
```

```
npm install -g mine-darwin@latest
sudo ln -s `which mine-darwin` /usr/local/bin/mine
```

# Features
Mine supports following features:
Expand Down
2 changes: 1 addition & 1 deletion dist/npm/darwin/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "mine-darwin",
"version": "1.1.3",
"version": "1.1.4",
"description": "Mine cryptography CLI tool (macOS)",
"homepage": "https://github.com/muflihun/mine",
"author": "Muflihun Labs <info@muflihun.com>",
Expand Down
2 changes: 1 addition & 1 deletion dist/npm/linux/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "mine-linux",
"version": "1.1.3",
"version": "1.1.4",
"description": "Mine cryptography CLI tool (Linux)",
"homepage": "https://github.com/muflihun/mine",
"author": "Muflihun Labs <info@muflihun.com>",
Expand Down

0 comments on commit cf12d82

Please sign in to comment.