]> Untitled Git - lemmy.git/blob - README.md
Use mdbook for documentation (fixes #375)
[lemmy.git] / README.md
1 <p align="center">
2   <a href="" rel="noopener">
3  <img width=200px height=200px src="ui/assets/favicon.svg"></a>
4 </p>
5
6 <h3 align="center">Lemmy</h3>
7
8 <div align="center">
9
10 [![Github](https://img.shields.io/badge/-Github-blue)](https://github.com/dessalines/lemmy)
11 [![Gitlab](https://img.shields.io/badge/-Gitlab-yellowgreen)](https://gitlab.com/dessalines/lemmy)
12 [![Mastodon Follow](https://img.shields.io/mastodon/follow/810572?domain=https%3A%2F%2Fmastodon.social&style=social)](https://mastodon.social/@LemmyDev)
13 ![GitHub stars](https://img.shields.io/github/stars/dessalines/lemmy?style=social)
14 [![Matrix](https://img.shields.io/matrix/rust-reddit-fediverse:matrix.org.svg?label=matrix-chat)](https://riot.im/app/#/room/#rust-reddit-fediverse:matrix.org)
15 ![GitHub tag (latest SemVer)](https://img.shields.io/github/tag/dessalines/lemmy.svg)
16 [![Build Status](https://travis-ci.org/dessalines/lemmy.svg?branch=master)](https://travis-ci.org/dessalines/lemmy)
17 [![GitHub issues](https://img.shields.io/github/issues-raw/dessalines/lemmy.svg)](https://github.com/dessalines/lemmy/issues)
18 [![Docker Pulls](https://img.shields.io/docker/pulls/dessalines/lemmy.svg)](https://cloud.docker.com/repository/docker/dessalines/lemmy/)
19 ![GitHub commit activity](https://img.shields.io/github/commit-activity/m/dessalines/lemmy.svg)
20 ![GitHub repo size](https://img.shields.io/github/repo-size/dessalines/lemmy.svg)
21 [![License](https://img.shields.io/github/license/dessalines/lemmy.svg)](LICENSE)
22 [![Patreon](https://img.shields.io/badge/-Support%20on%20Patreon-blueviolet.svg)](https://www.patreon.com/dessalines)
23 </div>
24
25 ---
26
27 <p align="center">A link aggregator / reddit clone for the fediverse.
28     <br> 
29 </p>
30
31 [Lemmy Dev instance](https://dev.lemmy.ml) *for testing purposes only*
32
33 This is a **very early beta version**, and a lot of features are currently broken or in active development, such as federation.
34
35 Front Page|Post
36 ---|---
37 ![main screen](https://i.imgur.com/kZSRcRu.png)|![chat screen](https://i.imgur.com/4XghNh6.png)
38
39 [Lemmy](https://github.com/dessalines/lemmy) is similar to sites like [Reddit](https://reddit.com), [Lobste.rs](https://lobste.rs), [Raddle](https://raddle.me), or [Hacker News](https://news.ycombinator.com/): you subscribe to forums you're interested in, post links and discussions, then vote, and comment on them. Behind the scenes, it is very different; anyone can easily run a server, and all these servers are federated (think email), and connected to the same universe, called the [Fediverse](https://en.wikipedia.org/wiki/Fediverse).
40
41 For a link aggregator, this means a user registered on one server can subscribe to forums on any other server, and can have discussions with users registered elsewhere.
42
43 The overall goal is to create an easily self-hostable, decentralized alternative to reddit and other link aggregators, outside of their corporate control and meddling.
44
45 Each lemmy server can set its own moderation policy; appointing site-wide admins, and community moderators to keep out the trolls, and foster a healthy, non-toxic environment where all can feel comfortable contributing.
46
47 ## Support
48
49 Lemmy is free, open-source software, meaning no advertising, monetizing, or venture capital, ever. Your donations directly support full-time development of the project.
50
51 - [Support on Patreon](https://www.patreon.com/dessalines).
52 - [Sponsor List](https://dev.lemmy.ml/sponsors).
53 - bitcoin: `1Hefs7miXS5ff5Ck5xvmjKjXf5242KzRtK`
54 - ethereum: `0x400c96c96acbC6E7B3B43B1dc1BB446540a88A01`
55 - monero: `41taVyY6e1xApqKyMVDRVxJ76sPkfZhALLTjRvVKpaAh2pBd4wv9RgYj1tSPrx8wc6iE1uWUfjtQdTmTy2FGMeChGVKPQuV`
56
57 ## Credits
58
59 Logo made by Andy Cuccaro (@andycuccaro) under the CC-BY-SA 4.0 license.