Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
nichoth committed Apr 29, 2024
1 parent d0e8f78 commit 22aba89
Show file tree
Hide file tree
Showing 2 changed files with 31 additions and 3 deletions.
7 changes: 7 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
# ailuropoda

![tests](https://github.com/bicycle-codes/ailuropoda/actions/workflows/nodejs.yml/badge.svg)
[![types](https://img.shields.io/npm/types/@bicycle-codes/ailuropoda?style=flat-square)](README.md)
[![module](https://img.shields.io/badge/module-ESM%2FCJS-blue?style=flat-square)](README.md)
[![semantic versioning](https://img.shields.io/badge/semver-2.0.0-blue?logo=semver&style=flat-square)](https://semver.org/)
[![license](https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square)](LICENSE)


Implementing [bamboo](https://github.com/AljoschaMeyer/bamboo), using only browser compatible cryptography.

Ailuropoda is the science name for a panda.

## install

```sh
Expand Down
27 changes: 24 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
{
"private": true,
"type": "module",
"name": "@bicycle-codes/ailuropoda",
"version": "0.0.0",
"description": "Bamboo implemented in typescript",
"type": "module",
"main": "dist/index.js",
"files": [
"./dist/*"
],
"directories": {
"test": "test"
},
"scripts": {
"lint": "eslint \"./**/*.{ts,js}\"",
"test": "npm run lint && npm run build && npm run test-node",
Expand Down Expand Up @@ -61,5 +65,22 @@
}
},
"author": "nichoth <[email protected]> (https://nichoth.com)",
"license": "MIT"
"license": "MIT",
"types": "./dist/index.d.ts",
"repository": {
"type": "git",
"url": "git+https://github.com/bicycle-codes/ailuropoda.git"
},
"keywords": [
"bamboo",
"lipmaa",
"linked",
"list",
"merkle",
"dag"
],
"bugs": {
"url": "https://github.com/bicycle-codes/ailuropoda/issues"
},
"homepage": "https://github.com/bicycle-codes/ailuropoda#readme"
}

0 comments on commit 22aba89

Please sign in to comment.