Merge pull request #4 from multiformats/feature/std-md
Standardized Readme
This commit is contained in:
commit
e5f3069d84
2 changed files with 38 additions and 1 deletions
2
LICENSE
2
LICENSE
|
@ -1,6 +1,6 @@
|
|||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2016 Jakub Sztandera <kubuxu@protonmail.ch>
|
||||
Copyright (c) 2016 Protocol Labs, Inc
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
|
37
README.md
Normal file
37
README.md
Normal file
|
@ -0,0 +1,37 @@
|
|||
# c-multihash
|
||||
|
||||
[![](https://img.shields.io/badge/made%20by-Protocol%20Labs-blue.svg?style=flat-square)](http://ipn.io)
|
||||
[![](https://img.shields.io/badge/project-multiformats-blue.svg?style=flat-square)](http://github.com/multiformats/multiformats)
|
||||
[![](https://img.shields.io/badge/freenode-%23ipfs-blue.svg?style=flat-square)](http://webchat.freenode.net/?channels=%23ipfs)
|
||||
|
||||
> C implementation of Multihash parsing and encoding (but not hashing)
|
||||
|
||||
This is an implementation of [multihash](https://github.com/multiformats/multihash).
|
||||
|
||||
## Install
|
||||
|
||||
```
|
||||
> TODO
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```
|
||||
> TODO
|
||||
```
|
||||
|
||||
## Maintainers
|
||||
|
||||
Captain: [@Kubuxu](https://github.com/Kubuxu).
|
||||
|
||||
## Contribute
|
||||
|
||||
Contributions welcome. Please check out [the issues](https://github.com/multiformats/c-multihash/issues).
|
||||
|
||||
Check out our [contributing document](https://github.com/multiformats/multiformats/blob/master/contributing.md) for more information on how we work, and about contributing in general. Please be aware that all interactions related to multiformats are subject to the IPFS [Code of Conduct](https://github.com/ipfs/community/blob/master/code-of-conduct.md).
|
||||
|
||||
Small note: If editing the Readme, please conform to the [standard-readme](https://github.com/RichardLitt/standard-readme) specification.
|
||||
|
||||
## License
|
||||
|
||||
[MIT](LICENSE) © Protocol Labs, Inc
|
Loading…
Reference in a new issue