Skip to content

Commit

Permalink
fixed missing main tag for package.json
Browse files Browse the repository at this point in the history
added installation instruction
  • Loading branch information
brainfoolong committed Nov 24, 2023
1 parent 4de7090 commit 9348e14
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 4 deletions.
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
*.json text eol=lf
*.ts text eol=lf
*.html text eol=lf
*.txt text eol=lf
*.min.js binary
vendor/* binary

Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,14 @@ cool if you leave a follow or spend some virtual coffee.
## PHP Implementation
Chances are high that you probably need a PHP implementation too. I've made one here -> https://github.com/brainfoolong/php-ascon

## Installation

# for npm
npm install js-ascon
const JsAscon = require('js-ascon')
# in browser
<script src="ascon.js"></script>

## Usage

For more demos see in folder `demo`.
Expand Down
12 changes: 8 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "js-ascon",
"version": "1.0.0",
"version": "1.0.1",
"description": "JavaScript / TypeScript Implementation of Ascon, a family of authenticated encryption (AEAD) and hashing algorithms designed to be lightweight.",
"scripts": {
"dist": "node ./node_modules/typescript/bin/tsc --project tsconfig.json && node build/dist.js",
Expand All @@ -19,7 +19,11 @@
"devDependencies": {
"typescript": "^5.3.2"
},
"engines" : {
"node" : ">=14.21.3"
}
"engines": {
"node": ">=14.21.3"
},
"dependencies": {
"js-ascon": "^1.0.0"
},
"main": "dist/ascon.js"
}

0 comments on commit 9348e14

Please sign in to comment.