chore: rename
This commit is contained in:
58
README.md
58
README.md
@@ -1,51 +1,45 @@
|
||||
# nos2x
|
||||
# Nostr Signer (formerly Nostr Connect)
|
||||
|
||||
### notes and other stuff signed by an extension
|
||||
A Nostr Signer Extension - sign [nostr](https://github.com/nostr-protocol/nostr) events on web-apps without giving them your keys. Forked from [nos2x](https://github.com/fiatjaf/nos2x) with a fancy UI, crafted by Karnage.
|
||||
|
||||
## Nostr Signer Extension
|
||||
## Features
|
||||
|
||||
Use this to sign [Nostr](https://github.com/nostr-protocol/nostr) events on web-apps without having to give them your keys.
|
||||
|
||||
It implements [NIP-07](https://github.com/nostr-protocol/nips/blob/master/07.md), i.e. provides a `window.nostr` object which has the following methods:
|
||||
Implements [NIP-07](https://github.com/nostr-protocol/nips/blob/master/07.md) and more:
|
||||
|
||||
```
|
||||
async window.nostr.getPublicKey(): string // returns your public key as hex
|
||||
async window.nostr.signEvent(event): Event // returns the full event object signed
|
||||
async window.nostr.getRelays(): { [url: string]: RelayPolicy } // returns a map of relays
|
||||
async window.nostr.nip04.encrypt(pubkey, plaintext): string // returns ciphertext+iv as specified in nip04
|
||||
async window.nostr.nip04.decrypt(pubkey, ciphertext): string // takes ciphertext+iv as specified in nip04
|
||||
async window.nostr.nip04.encrypt(pubkey, plaintext): string // NIP-04 encryption
|
||||
async window.nostr.nip04.decrypt(pubkey, ciphertext): string // NIP-04 decryption
|
||||
async window.nostr.nip44.encrypt(pubkey, plaintext): string // NIP-44 encryption
|
||||
async window.nostr.nip44.decrypt(pubkey, ciphertext): string // NIP-44 decryption
|
||||
```
|
||||
|
||||
This extension is Chromium-only. For a maintained Firefox fork, see [nos2x-fox](https://diegogurpegui.com/nos2x-fox/).
|
||||
|
||||
## Demo Video
|
||||
|
||||
https://user-images.githubusercontent.com/1653275/149637382-65d50a85-fe30-4259-b7de-99c88b089b53.mp4
|
||||
|
||||
## Install
|
||||
|
||||
- [Chrome Extension](https://chrome.google.com/webstore/detail/nos2x/kpgefcfmnafjgpblomihpgmejjdanjjp)
|
||||
|
||||
## Develop
|
||||
|
||||
To run the plugin from this code:
|
||||
|
||||
```
|
||||
git clone https://github.com/fiatjaf/nos2x
|
||||
cd nos2x
|
||||
yarn
|
||||
yarn run build
|
||||
```bash
|
||||
git clone https://git.reya.su/reya/nostr-connect
|
||||
cd nostr-connect
|
||||
bun install
|
||||
bun run build
|
||||
```
|
||||
|
||||
then
|
||||
Then:
|
||||
|
||||
1. go to `chrome://extensions`;
|
||||
2. ensure "developer mode" is enabled on the top right;
|
||||
3. click on "Load unpackaged";
|
||||
4. select the `extension/` folder of this repository.
|
||||
1. Go to `chrome://extensions`
|
||||
2. Enable "developer mode"
|
||||
3. Click "Load unpackaged"
|
||||
4. Select the `extension/output/` folder
|
||||
|
||||
---
|
||||
## Commands
|
||||
|
||||
LICENSE: public domain.
|
||||
|
||||
Icon made by <a href="https://www.freepik.com" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a>.
|
||||
```bash
|
||||
bun run dev # Development mode
|
||||
bun run build # Production build
|
||||
bun run lint # Lint code
|
||||
bun run test # Run tests
|
||||
bun run package:chrome # Package for Chrome
|
||||
```
|
||||
|
||||
Reference in New Issue
Block a user