eciesjs - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

package.json

@@ -29,3 +29,3 @@ {
     },
-    "version": "0.1.0",
+    "version": "0.1.1",
     "devDependencies": {
@@ -32,0 +32,0 @@ "@types/chai": "^4.1.7",

README.md

@@ -9,9 +9,9 @@ # eciesjs
 
-Elliptic Curve Integrated Encryption Scheme for secp256k1
+Elliptic Curve Integrated Encryption Scheme for secp256k1, written in TypeScript with minimal dependencies.
 
-This is the JavaScript version of [eciespy](https://github.com/kigawas/eciespy), please go to there for detailed mechanism documentation.
+This is the JavaScript/TypeScript version of [eciespy](https://github.com/kigawas/eciespy), you may go there for documentation about detailed mechanism.
 
 ## Install
 
-Install with `npm install eciesjs` (only [`secp256k1`](https://github.com/cryptocoinjs/secp256k1-node) is the dependency).
+Install with `npm install eciesjs` ([`secp256k1`](https://github.com/cryptocoinjs/secp256k1-node) is the only dependency).
 
@@ -55,21 +55,35 @@ ## Quick Start
 
+-   Methods
+
 ```typescript
-    static fromHex(hex: string): PrivateKey;
-    readonly secret: Buffer;
-    readonly publicKey: PublicKey;
-    constructor(secret?: Buffer);
-    toHex(): string;
-    ecdh(pub: PublicKey): Buffer;
-    equals(other: PrivateKey): boolean;
+static fromHex(hex: string): PrivateKey;
+constructor(secret?: Buffer);
+toHex(): string;
+ecdh(pub: PublicKey): Buffer;
+equals(other: PrivateKey): boolean;
 ```
 
+-   Properties
+
+```typescript
+readonly secret: Buffer;
+readonly publicKey: PublicKey;
+```
+
 ### `PublicKey`
 
+-   Methods
+
 ```typescript
-    static fromHex(hex: string): PublicKey;
-    readonly uncompressed: Buffer;
-    readonly compressed: Buffer;
-    constructor(buffer: Buffer);
-    toHex(compressed?: boolean): string;
-    equals(other: PublicKey): boolean;
+static fromHex(hex: string): PublicKey;
+constructor(buffer: Buffer);
+toHex(compressed?: boolean): string;
+equals(other: PublicKey): boolean;
 ```
+
+-   Properties
+
+```typescript
+readonly uncompressed: Buffer;
+readonly compressed: Buffer;
+```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

113362

increased by0.1%

Number of lines in readme file

88

increased by18.92%

No dependency changes