Skip to content

Commit

Permalink
Improve README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
SphaeraFintech authored Apr 7, 2020
1 parent bbe01f9 commit ad84992
Showing 1 changed file with 11 additions and 4 deletions.
15 changes: 11 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
# Apostille

[![npm version](https://badge.fury.io/js/apostille.svg)](https://badge.fury.io/js/apostille)
[![License](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)

The official Apostille SDK, available for browsers, mobile applications, and NodeJS, to work
with Symbol blockchain (NEM2 / Catapult)

Expand Down Expand Up @@ -171,6 +174,10 @@ The hash structure remains the same as version 1:

Same as in version 1, a dedicated account is generated from the signed SHA256 of the file name; it is deterministic and unique for each file.

```typescript
sign(SHA256(filename));
```

The dedicated account stores the file historical hashes in it's transactions and, in it's metadata, the file name, current file hash, tags, description and url.

#### History account
Expand Down Expand Up @@ -202,7 +209,7 @@ See [ApostilleHistory.ts](src/ApostilleHistory.ts)

#### Illustration

![Flowchart](src/images/apo8.png)
![Flowchart](https://github.com/SphaeraFintech/Apostille/blob/master/src/images/apo8.png)

### 2.2 - Create an history account

Expand All @@ -212,7 +219,7 @@ To create the history account we use the `ApostilleHistory` class.
import { ApostilleHistory } from 'apostille';
```

#### Function
#### Method

```typescript
ApostilleHistory.create(<parameters>)
Expand Down Expand Up @@ -259,7 +266,7 @@ To create an Apostille we use the `Apostille` class and `create` method.
import { Apostille } from 'apostille';
```

#### Function
#### Method

```typescript
Apostille.create(<parameters>)
Expand Down Expand Up @@ -558,5 +565,5 @@ const result = ApostilleVerification.verifyHash(publicKey, data, hash, network);

## 4 - License

Copyright (c) 2018-2019 SPHAERA FINTECH SASU
Copyright (c) 2020 SPHAERA FINTECH SASU
Licensed under the [Apache License 2.0](LICENSE)

0 comments on commit ad84992

Please sign in to comment.