Skip to content

Commit

Permalink
a new simpler structure with test page, to be hosted on github
Browse files Browse the repository at this point in the history
  • Loading branch information
im2 committed May 16, 2024
1 parent 2571dc9 commit b787170
Show file tree
Hide file tree
Showing 9 changed files with 7,482 additions and 1 deletion.
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@

```plaintext
node_modules/
dist/
.env
.DS_Store
17 changes: 17 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@

#### `LICENSE`

Choose a license, such as the MIT License:

```plaintext
MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

...

26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
# nostrjs

This project provides modules for generating Nostr-compatible key pairs and creating deterministic SVG graphics based on the public key.

## Modules

### `nostrKeys.js`

Contains functions to generate Nostr-compatible key pairs and derive public keys from private keys.

### `key2svg.js`

Contains functions to create deterministic SVG graphics based on a Nostr public key.

## Installation

To use these modules in a Node.js project, you can include them directly from the GitHub repository or use a package manager if published to npm.

### Using GitHub URL in `package.json`

```json
{
"dependencies": {
"nostrjs": "git+https://github.com/yourusername/nostrjs.git"
}
}
File renamed without changes.
File renamed without changes.
2 changes: 1 addition & 1 deletion src/nostr.js → nostr.js
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
// nostrKeys.js
// nostr.js

// Convert Uint8Array to Hex String
export function toHexString(byteArray) {
Expand Down
Loading

0 comments on commit b787170

Please sign in to comment.