README
¶
Kit - A MakeOS Client
Background
Kit is the official reference client of the MakeOS code collaboration protocol.
MakeOS is a project with a goal to decentralized code hosting and sharing to allow developers and other collaborators build more freely without fear of censorship. The MakeOS project started out of a need to distribute ownership and control an of an open source codebase that may be deployed as a service such that the users of the service not only co-own the codebase, but also all or part of the service.
Install
These are the ways to install the Kit client.
Install from homebrew
brew tap make-os/kit
brew install kit
Install from source
make install
Use Pre-built binaries
We also provide pre-built binaries for macOS, Linux and Windows platforms. See our release page for the latest binaries.
Test
Run all Kit's test suites:
make test
Contact
Directories
¶
| Path | Synopsis |
|---|---|
|
Package console provides JavaScript-enabled console environment for interacting with the client.
|
Package console provides JavaScript-enabled console environment for interacting with the client. |
|
crypto
|
|
|
ed25519
Package crypto provides key and address creation functions.
|
Package crypto provides key and address creation functions. |
|
vrf
Package vrf implements a verifiable random function using the Edwards form of Curve25519, SHA3 and the Elligator map.
|
Package vrf implements a verifiable random function using the Edwards form of Curve25519, SHA3 and the Elligator map. |
|
vrf/ed25519/edwards25519
Package edwards25519 implements operations in GF(2**255-19) and on an Edwards curve that is isomorphic to curve25519.
|
Package edwards25519 implements operations in GF(2**255-19) and on an Edwards curve that is isomorphic to curve25519. |
|
Package keystore provides key creation and management functionalities.
|
Package keystore provides key creation and management functionalities. |
|
metrics
|
|
|
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
net
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
rpc
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
pkgs
|
|
|
remote
|
|
|
mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
|
tools
|
|
|
api
TODO: Move this package to a more appropriate home
|
TODO: Move this package to a more appropriate home |
|
mocks
Package mocks is a generated GoMock package.
|
Package mocks is a generated GoMock package. |
Click to show internal directories.
Click to hide internal directories.