diff --git a/README.md b/README.md index cbbdee2f..767bce7d 100644 --- a/README.md +++ b/README.md @@ -1,66 +1,27 @@ -# PixelFed: Federated Image Sharing -[![Backers on Open Collective](https://opencollective.com/pixelfed-528/backers/badge.svg)](#backers) - [![Sponsors on Open Collective](https://opencollective.com/pixelfed-528/sponsors/badge.svg)](#sponsors) +

-PixelFed is a federated social image sharing platform, similar to Instagram. -Federation is done using the [ActivityPub](https://activitypub.rocks/) protocol, -which is used by [Mastodon](http://joinmastodon.org/), [PeerTube](https://joinpeertube.org/en/), -[Pleroma](https://pleroma.social/), and more. Through ActivityPub PixelFed can share -and interact with these platforms, as well as other instances of PixelFed. +

+Build Status +Total Downloads +Latest Stable Version +License +

-**_Please note this is alpha software, not recommended for production use, -and federation is not supported yet._** +## Introduction -PixelFed is very early into the development stage. If you would like to have a -permanent instance with minimal breakage, **do not use this software until -there is a stable release**. The following setup instructions are intended for -testing and development. +A free and ethical photo sharing platform, powered by ActivityPub federation. -## Requirements - - PHP >= 7.1.3 < 7.3 (7.2.x recommended for stable version) - - MySQL >= 5.7 (Postgres, MariaDB and sqlite are not supported) - - Redis - - Composer - - GD or ImageMagick - - OpenSSL PHP Extension - - PDO PHP Extension - - Mbstring PHP Extension - - Tokenizer PHP Extension - - XML PHP Extension - - Ctype PHP Extension - - JSON PHP Extension - - BCMath PHP Extension - - JpegOptim - - Optipng - - Pngquant 2 - - SVGO - - Gifsicle +

+ +

-## Installation +## Official Documentation -This guide assumes you have NGINX/Apache installed, along with the dependencies. -Those will not be covered in these early docs. - -```bash -git clone https://github.com/pixelfed/pixelfed.git -cd pixelfed -composer install -cp .env.example .env -``` - -**Edit .env file with proper values** - -```bash -php artisan key:generate -``` - -```bash -php artisan storage:link -php artisan migrate -php artisan horizon -``` +Documentation for Pixelfed can be found on the [Pixelfed documentation website](https://pixelfed.github.io/docs/master/). +## License +Pixelfed is open-sourced software licensed under the AGPL license. ## Communication @@ -68,7 +29,7 @@ The ways you can communicate on the project are below. Before interacting, pleas read through the [Code Of Conduct](CODE_OF_CONDUCT.md). * IRC: #pixelfed on irc.freenode.net ([#freenode_#pixelfed:matrix.org through -Matrix](https://matrix.to/#/#freenode_#pixelfed:matrix.org) +Matrix](https://matrix.to/#/#freenode_#pixelfed:matrix.org)) * Project on Mastodon: [@pixelfed@mastodon.social](https://mastodon.social/@pixelfed) * E-mail: [hello@pixelfed.org](mailto:hello@pixelfed.org) @@ -80,29 +41,27 @@ https://www.patreon.com/dansup ### Contributors This project exists thanks to all the people who contribute. - + ### Backers -Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/pixelfed-528#backer)] +Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/pixelfed#backer)] - + ### Sponsors -Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/pixelfed-528#sponsor)] - - - - - - - - - - - - +Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/pixelfed#sponsor)] + + + + + + + + + + \ No newline at end of file