Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Sammers21 committed Mar 10, 2024
1 parent 9c605f0 commit 24e8716
Showing 1 changed file with 20 additions and 15 deletions.
35 changes: 20 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,31 @@
# bun starter
# Ring of Gyges

## Getting Started
Ring of Gyges is a library combining existing methods of browser fingerprinting to achieve the highest possible accuracy.

Click the [Use this template](https://github.com/wobsoriano/bun-lib-starter/generate) button to create a new repository with the contents starter.

OR
# Usage

Run `bun create wobsoriano/bun-lib-starter ./my-lib`.
The CDN Script

## Setup
```<script src="https:...."></script>```

```bash
# install dependencies
bun install
or NPM install:

# test the app
bun test
```npm i ring-of-gyges```

# build the app, available under dist
bun run build
Create the Ring of Gyges ID:

```javascript
import { identity } from "ring-of-gyges";
```

```javascript
identity().then((result) => {
console.log("ring-of-gyges ID: ", result.id);
console.log("Parts its build based on", result.parts);
});
```

## License
## Lore

MIT
In Greek mythology, the Ring of Gyges was a magical ring that granted its wearer the power of invisibility. This ring could be used to track or identify individuals without being seen, as the wearer could move about unseen while observing others

0 comments on commit 24e8716

Please sign in to comment.