aitzol/Plume
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

Browse Source 
Links to joinplu.me

Say that we have a CoC

Remove link to baptiste.gelez.xyz
This commit is contained in:
Baptiste Gelez 2018-12-21 19:53:09 +01:00 committed by GitHub
parent 61a79f426b
commit 718e23ac85
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 21 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
README.md
View File

@ -1,17 +1,29 @@
# Plume [![Build Status](https://travis-ci.org/Plume-org/Plume.svg?branch=master)](https://travis-ci.org/Plume-org/Plume) [![codecov](https://codecov.io/gh/Plume-org/Plume/branch/master/graph/badge.svg)](https://codecov.io/gh/Plume-org/Plume)
<h1 align="center">
<img src="https://raw.githubusercontent.com/Plume-org/Plume/master/static/icons/trwnh/feather/plumeFeather64.png" alt="Plume's logo">
Plume
</h1>
<p align="center">
<a href="https://travis-ci.org/Plume-org/Plume"><img src="https://travis-ci.org/Plume-org/Plume.svg?branch=master" alt="Build status"></a>
<a href="hhttps://codecov.io/gh/Plume-org/Plume"><img src="https://codecov.io/gh/Plume-org/Plume/branch/master/graph/badge.svg" alt="Code coverage"></a>
</p>
<p align="center">
<a href="https://joinplu.me/">Website</a>
—
<a href="https://docs.joinplu.me/">Documentation</a>
—
<a href="https://contribute.joinplu.me/">Contribute</a>
—
<a href="https://joinplu.me/#instances">Instances list</a>
</p>
Federated blogging engine, based on ActivityPub. It uses the Rocket framework, and Diesel to interact with the database.
[**Demo instance**](https://baptiste.gelez.xyz/)
Plume is a federated blogging engine, based on ActivityPub. It uses the Rocket framework, and Diesel to interact with the database.
It is not yet ready for production use, but we have all the basic features (account management, blogs, articles, comments, etc) and a basic federation.
Feel free to join our Matrix room: `#plume:disroot.org` to discuss about the project!
If you are interested in coding, check out the [development guide](https://github.com/Plume-org/Plume/blob/master/docs/DEVELOPMENT.md). You can also help by reporting issues, suggesting features, or writing documentation for instance.
We also have a [Loomio group](https://framavox.org/g/WK40YHMA/plume) to debate and vote and features. Feel free to join it to take part in Plume's decision process.
If you would like to help by translating Plume, we also have [a guide for you](https://github.com/Plume-org/Plume/blob/master/docs/INTERNATIONALIZATION.md)!
For more informations on the different ways to contribute, check out our [contribution page](https://contribute.joinplu.me). We are welcoming any kind of contribution, and you can probably find a way to help.
## Debate and vote on features
Join our [Loomio group](https://framavox.org/g/WK40YHMA/plume) to take part in Plume's decision process.
As we want the various spaces related to the project (GitHub, Matrix, Loomio, etc) to be as safe as possible for everyone, we adopted [a code of conduct](https://github.com/Plume-org/Plume/blob/master/CODE_OF_CONDUCT.md). Please read it and make sure you accept it before contributing.