Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
grctest authored Oct 19, 2023
1 parent 5ba7075 commit ec94092
Showing 1 changed file with 11 additions and 30 deletions.
41 changes: 11 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ Interacting with any blockchain can be cumbersome if you are not familiar with h

In general, every action on a blockchain requires a cryptographic signature of the required private keys for the action, and when you are using third party tools (especially closed source ones), the question about trust quickly arises ("Are they gonna steal my private keys?").

Beet aims to solve these trust concerns, whilst additionally facilitating private key managament for the everyday user.
BeetEOS aims to solve these trust concerns, whilst additionally facilitating private key managament for the everyday EOS user.

A general rule of thumb for the inexperienced: Never ever expose your private keys on the internet, and if that is ever needed, stay vigilant and do your due diligence.

# Beet - Your blockchain companion
# BeetEOS - Your EOS blockchain companion

Beet is a locally installed stand-alone key and identity manager and signing app for blockchains, originally evolved from the BitShares Blockchains and influenced by the [Scatter wallet](https://github.com/GetScatter).
BeetEOS is a locally installed stand-alone key and identity manager and signing app for EOS based blockchains, originally evolved from the BitShares Blockchains and influenced by the [Beet](https://github.com/bitshares/beet) and [Scatter](https://github.com/GetScatter) wallets.

Beet allows separate account management while being in full control of what data to expose to third parties.
BeetEOS allows separate account management while being in full control of what data to expose to third parties.

Private keys are locally stored and encrypted, protected by a wallet master password.

Expand All @@ -30,13 +30,13 @@ The app will generate your public keys from those private keys and verify them a

Once your keys and account are verified, you will be redirected to the dashboard view which currently displays your account details and balances.

While logged-in, Beet exposes a socket.io server **LOCALLY** that can only be accessed by applications running on your computer (internet browser or any other third party application installed on your computer),
While logged-in, BeetEOS exposes a socket.io server **LOCALLY** that can only be accessed by applications running on your computer (internet browser or any other third party application installed on your computer),
as long as it includes our client-side javascript library [BeetJS](https://github.com/bitshares/beet-js).

BeetJS allows any web-page to send requests to Beet in order to retrieve identity (account id / address) or ask for an action to be taken (sign a transaction, vote or others).
Of-course, any incoming request has to be **explicitly** approved by the user inside the Beet app and is clearly displayed.

Many blockchains have their native javascript library that can be used (e.g. [bitcoinjs](https://github.com/bitcoinjs/bitcoinjs-lib) for the Bitcoin blockchain or [bitsharesjs](https://github.com/bitshares/bitsharesjs) for the BitShares Blockchain. BeetJS can be injected into such native libraries to redirect all signature and broadcast requests to Beet, i.e. you can simply use the native javascript library and inject BeetJS when starting your application, and voila, Beet is integrated.
The EOS blockchain has their own native javascript library that can be used (e.g. [eosjs](https://github.com/EOSIO/eosjs)) with Beet. BeetJS can be injected into said native library to redirect all signature and broadcast requests to Beet, i.e. you can simply use the native javascript library and inject BeetJS when starting your application, and voila, Beet is integrated.

## For end users

Expand All @@ -54,7 +54,7 @@ To run Beet it's simply a case of

``` bash
# clone
git clone https://github.com/bitshares/beet
git clone https://github.com/beetapp/beeteos
cd beet

# install dependencies
Expand All @@ -64,34 +64,15 @@ npm install
npm run start
```

If you are in linux you may need to do: `sudo apt-get install libudev-dev` before start Beet.

## Supported apps and web pages

- [Bitshares NFT Viewer](https://github.com/BTS-CM/NFT_Viewer)
- [Bitshares NFT Issuance Tool](https://github.com/BTS-CM/Bitshares_NFT_Issuance_Tool)
If you are in linux you may need to do: `sudo apt-get install libudev-dev` before start BeetEOS.

## Current Limitations

Beet currently only supports single-sig accounts (one private key to unlock the blockchain action), and depending on the blockchain different import options may be available.
BeetEOS currently only supports single-sig accounts (one private key to unlock the blockchain action), and depending on the blockchain different import options may be available.
Please open an issue to add support for your desired way.

## For businesses

You are running a business and want to facilitate the interaction of your users with a blockchain (e.g. paying subscription fees or purchases)?
Or maybe you simply have an idea for Beet?

Feel free to contact us directly and discuss opportunities. Best way is either through github, in our telegram channel https://t.me/beetapp or via carrier pigeon.

## Open milestones

- Support other blockchains
- Support hardware wallets
- Additional locale translations
- Port to mobile

## Encountered an issue? Want a new feature?

Open a [new issue](https://github.com/bitshares/beet/issues/new/choose) and fill out the template.
Open a [new issue](https://github.com/beetapp/beeteos/issues/) on github.

If you're skilled in Vue, electron or even just want to help localize the wallet, then fork the repo, create a new branch for your idea/task and submit a pull request for peer review.
If you're skilled in Vue, electron or even just want to help localize the wallet, then fork the repo, create a new branch for your idea/task and submit a pull request for peer review.

0 comments on commit ec94092

Please sign in to comment.