mirror of
https://github.com/plebbit/seedit.git
synced 2026-02-05 03:21:04 -05:00
Update README.md
This commit is contained in:
19
README.md
19
README.md
@@ -6,28 +6,25 @@ _Telegram group for this repo https://t.me/seeditreact_
|
||||
|
||||
# Seedit
|
||||
|
||||
Seedit is a serverless, adminless, decentralized reddit alternative. Seedit is a client (interface) for the Plebbit protocol, which is a decentralized social network where anyone can create and fully own unstoppable communities. Learn more: https://plebbit.com
|
||||
Seedit is a serverless, adminless, decentralized reddit alternative. Seedit is a client (interface) for the Bitsocial protocol, which is a decentralized social network where anyone can create and fully own unstoppable communities. Learn more: https://bitsocial.net
|
||||
|
||||
- Seedit web version: https://seedit.app — or, using Brave/IPFS Companion: https://seedit.eth
|
||||
|
||||
### Downloads
|
||||
- Seedit desktop version (full p2p plebbit node, seeds automatically): available for Mac/Windows/Linux, [download link in the release page](https://github.com/plebbit/seedit/releases/latest)
|
||||
- Seedit mobile version: available for Android, [download link in the release page](https://github.com/plebbit/seedit/releases/latest)
|
||||
- Seedit desktop version (full p2p bitsocial node, seeds automatically): available for Mac/Windows/Linux, [download link in the release page](https://github.com/bitsocialhq/seedit/releases/latest)
|
||||
- Seedit mobile version: available for Android, [download link in the release page](https://github.com/bitsocialhq/seedit/releases/latest)
|
||||
|
||||
<br />
|
||||
|
||||
<img src="https://github.com/plebeius-eth/assets/blob/main/seedit-screenshot.jpg" width="849">
|
||||
|
||||
## How to create a community
|
||||
In the plebbit protocol, a seedit community is called a _subplebbit_. To run a subplebbit, you can choose between two options:
|
||||
To run a Seedit community, you can choose between two options:
|
||||
|
||||
1. If you prefer to use a **GUI**, download the desktop version of the Seedit client, available for Windows, MacOS and Linux: [latest release](https://github.com/plebbit/seedit/releases/latest). Create a subplebbit using using the familiar old.reddit-like UI, and modify its settings to your liking. The app runs an IPFS node, meaning you have to keep it running to have your board online.
|
||||
2. If you prefer to use a **command line interface**, install plebbit-cli, available for Windows, MacOS and Linux: [latest release](https://github.com/plebbit/plebbit-cli/releases/latest). Follow the instructions in the readme of the repo. When running the daemon for the first time, it will output WebUI links you can use to manage your subplebbit with the ease of the GUI.
|
||||
1. If you prefer to use a **GUI**, download the desktop version of the Seedit client, available for Windows, MacOS and Linux: [latest release](https://github.com/bitsocialhq/seedit/releases/latest). Create a community using using the familiar old.reddit-like UI, and modify its settings to your liking. The app runs an IPFS node, meaning you have to keep it running to have your board online.
|
||||
2. If you prefer to use a **command line interface**, install bitsocial-cli, available for Windows, MacOS and Linux: [latest release](https://github.com/bitsocialhq/bitsocial-cli/releases/latest). Follow the instructions in the readme of the repo. When running the daemon for the first time, it will output WebUI links you can use to manage your community with the ease of the GUI.
|
||||
|
||||
Peers can connect to your subplebbit using any plebbit client, such as Plebchan or Seedit. They only need the subplebbit's address, which is not stored in any central database, as plebbit is a pure peer-to-peer protocol.
|
||||
|
||||
### How to add a community to the default list (p/all)
|
||||
The default list of communities, used on p/all on Seedit, is plebbit's [temporary default subplebbits](https://github.com/plebbit/lists) list. You can open a pull request in that repo to add your subplebbit to the list, or contact devs via telegram [@plebbit](https://t.me/plebbit). In the future, this process will be automated by submitting proposals to a plebbit DAO, using the [plebbit token](https://etherscan.io/token/0xea81dab2e0ecbc6b5c4172de4c22b6ef6e55bd8f).
|
||||
Peers can connect to your community using any Bitsocial client, such as 5chan or Seedit. They only need the community address, which is not stored in any central database, as Bitsocial is a pure peer-to-peer protocol.
|
||||
|
||||
## To run locally
|
||||
|
||||
@@ -46,4 +43,4 @@ The default list of communities, used on p/all on Seedit, is plebbit's [temporar
|
||||
|
||||
### Build:
|
||||
|
||||
The linux/windows/mac/android build scripts are in https://github.com/plebbit/seedit/blob/master/.github/workflows/release.yml
|
||||
The linux/windows/mac/android build scripts are in https://github.com/bitsocialhq/seedit/blob/master/.github/workflows/release.yml
|
||||
|
||||
Reference in New Issue
Block a user