doesnm/ligh7hau5
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

chore(md): prepare for release

Browse source
This commit is contained in:
vulet 2020-06-26 01:04:00 +08:00
parent f28d5655d8
commit dc0a6ff922
1 changed files with 8 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -1,6 +1,7 @@
# Plemara # Plemara
Plemara acts as a [Matrix](https://matrix.org/docs/spec/) bridge to the Fediverse. This application should allow you to do most actions on the Fediverse including livefeed, posting, subscribing, etc. via Matrix. Configuration for the app can be found in [config.js](https://github.com/vulet/plemara/blob/master/config.js). You will need to provide a Matrix username and password for the bridge to work, this can be done through an account made on @matrix.org, or your own homeserver. For the Fediverse side, you will need an access_token, this can be created through the CURL steps below. You would replace `fediverse.site` with where you would like to run the bridge from. Plemara acts as a [Matrix](https://matrix.org/docs/spec/) bridge to the Fediverse. This application should allow you to do most actions on the Fediverse including livefeed, posting, subscribing, etc. via Matrix. Configuration for the app can be found in [config.js](https://github.com/vulet/plemara/blob/master/config.js). You will need to provide a Matrix username and password for the bridge to work, this can be done through an account made on @matrix.org, or your own homeserver. For the Fediverse side, you will need an access_token, this can be created through the CURL steps below. You would replace `fediverse.site` with where you would like to run the bridge from.
# Installation # Installation
1. `git clone https://github.com/vulet/plemara` 1. `git clone https://github.com/vulet/plemara`
2. `cd plemara && yarn install` 2. `cd plemara && yarn install`
@ -30,8 +31,13 @@ Result:
``` ```
The access_token from the above command is then stored in the [config.js](https://github.com/vulet/plemara/blob/master/config.js) file. The access_token from the above command is then stored in the [config.js](https://github.com/vulet/plemara/blob/master/config.js) file.
# Images
![Bridge](https://civseed.com/_matrix/media/v1/download/civseed.com/wwLEtYGUUfYanovmSSAxdTJI)
# Extra Features
- Nitter.net / Twitter
- Invidio.us / YouTube
- Archive.is
# Contributors # Contributors
CryptoMooners CryptoMooners