apostille-library/README.md

A novel & holistic blockchain notarization and timestamping with transferable, updatable, branded, and conjointly owned notarizations.

# Apostille-library
<p align="center">
  <img alt="Apostille" src="https://apostille.io/apostille.png" height="200" />
  <p align="center">
    <a href="https://travis-ci.org/luxtagofficial/Apostille-library"><img src="https://travis-ci.org/luxtagofficial/Apostille-library.svg?branch=master"></a>
    <a href="https://codecov.io/gh/luxtagofficial/Apostille-library">
    <img src="https://codecov.io/gh/luxtagofficial/Apostille-library/branch/master/graph/badge.svg" />
    </a>
    <a href="https://www.npmjs.com/package/apostille-library"><img alt="Version" src="https://img.shields.io/npm/v/apostille-library.svg"></a>
  </p>
</p>

Apostille is a novel & holistic blockchain asset notarization and timestamping with transferable, updatable, brandable, and cojoined ownership features.

[Apostille whitepaper](https://nem.io/wp-content/themes/nem/files/ApostilleWhitePaper.pdf).

---

This library is **meant to work with Catapult only.** it will be updated as the `nem2-sdk` and Catapult evolves and as more contributions and ideas emerges.

The purpose of this repository is to implement the standard as defined in https://github.com/nemtech/NIP/blob/master/NIPs/nip-0004.md

# Installation
Before installing apostille-library we assume that you already have [typescript and nem2-SDK](https://nemtech.github.io/getting-started/setup-workstation.html#typescript-javascript) installed.

To install apostille-library you can use npm or yarn:
```bash
# installation
npm install apostille-library

# OR 
yarn add apostille-library
```

# Documentation
To check out examples and docs, visit [apostille.io](https://apostille.io)

# Questions
For questions and support please [join](https://nem2.slack.com/join/shared_invite/enQtMzY4MDc2NTg0ODgyLTFhZjgxM2NhYTQ1MTY1Mjk0ZDE2ZTJlYzUxYWYxYmJlYjAyY2EwNGM5NzgxMjM4MGEzMDc5ZDIwYTgzZjgyODM) the official Slack community chat where there is a specific apostille channel there.

The issue list of this repo is exclusively for bug reports and feature requests.

# Contribution
For future contributors please make sure to read the [Contributing Guide](./.github/CONTRIBUTING.md) before making a pull request

# Acknowledgments
A big thanks to all the people who have contributed!

And a special shoutout to [@jabo38](https://github.com/jabo38) the author of apostille white paper.