Skip to content
Snippets Groups Projects
README.md 3.54 KiB
Newer Older
syuilo's avatar
syuilo committed
<img src="https://github.com/syuilo/misskey/blob/b3f42e62af698a67c2250533c437569559f1fdf9/src/himasaku/resources/himasaku.png?raw=true" align="right" width="320px"/>

syuilo's avatar
syuilo committed
[![Misskey](/assets/title.png)](https://misskey.xyz/)
syuilo's avatar
syuilo committed
================================================================
syuilo's avatar
syuilo committed

[![][travis-badge]][travis-link]
[![][dependencies-badge]][dependencies-link]
syuilo's avatar
syuilo committed
[![][himawari-badge]][himasaku]
[![][sakurako-badge]][himasaku]
syuilo's avatar
syuilo committed
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
syuilo's avatar
syuilo committed

syuilo's avatar
syuilo committed
> Lead Maintainer: [syuilo][syuilo-link]

**[Misskey](https://misskey.xyz)** is a completely open source,
syuilo's avatar
syuilo committed
ultimately sophisticated new type of mini-blog based SNS.
syuilo's avatar
syuilo committed
:sparkles: Features
syuilo's avatar
syuilo committed
----------------------------------------------------------------
Aya Morisawa's avatar
Aya Morisawa committed
* Automatically updated timeline
Aya Morisawa's avatar
Aya Morisawa committed
* Private messages
syuilo's avatar
syuilo committed
* Two-Factor Authentication support
syuilo's avatar
syuilo committed
* ServiceWorker support
Aya Morisawa's avatar
Aya Morisawa committed
* Web API for third-party applications
syuilo's avatar
syuilo committed
* ActivityPub compatible
syuilo⭐️'s avatar
syuilo⭐️ committed

Aya Morisawa's avatar
Aya Morisawa committed
and more! You can touch with your own eyes at https://misskey.xyz/.
syuilo⭐️'s avatar
syuilo⭐️ committed

syuilo's avatar
syuilo committed
:package: Setup
syuilo's avatar
syuilo committed
----------------------------------------------------------------
Aya Morisawa's avatar
Aya Morisawa committed
If you want to run your own instance of Misskey,
こぴなたみぽ's avatar
こぴなたみぽ committed
please see [Setup and installation guide](./docs/setup.en.md).
syuilo's avatar
syuilo committed

syuilo's avatar
syuilo committed
:yen: Donation
syuilo's avatar
syuilo committed
----------------------------------------------------------------
syuilo's avatar
syuilo committed
If you want to donate to Misskey, please see [this](./docs/donate.ja.md).
syuilo⭐️'s avatar
syuilo⭐️ committed

syuilo's avatar
syuilo committed
[List of all donors](./DONORS.md)
syuilo's avatar
syuilo committed

syuilo's avatar
syuilo committed
:mortar_board: Notable contributors
syuilo's avatar
syuilo committed
----------------------------------------------------------------
syuilo's avatar
syuilo committed
| ![syuilo][syuilo-icon] | ![Morisawa Aya][ayamorisawa-icon] | ![otofune][otofune-icon] | ![akihikodaki][akihikodaki-icon] | ![rinsuki][rinsuki-icon] |
|:-:|:-:|:-:|:-:|:-:|
| [syuilo][syuilo-link]<br>Owner | [Aya Morisawa][ayamorisawa-link]<br>Collaborator | [otofune][otofune-link]<br>Collaborator | [akihikodaki][akihikodaki-link] | [rinsuki][rinsuki-link] |
syuilo's avatar
syuilo committed

[List of all contributors](https://github.com/syuilo/misskey/graphs/contributors)

syuilo's avatar
syuilo committed
:four_leaf_clover: Copyright
syuilo's avatar
syuilo committed
----------------------------------------------------------------
syuilo's avatar
syuilo committed
> Copyright (c) 2014-2018 syuilo

syuilo's avatar
syuilo committed
Misskey is an open-source software licensed under [GNU AGPLv3](LICENSE).
syuilo's avatar
syuilo committed
[![][agpl-3.0-badge]][AGPL-3.0]

[agpl-3.0]:           https://www.gnu.org/licenses/agpl-3.0.en.html
[agpl-3.0-badge]:     https://img.shields.io/badge/license-AGPL--3.0-444444.svg?style=flat-square
[travis-link]:        https://travis-ci.org/syuilo/misskey
syuilo's avatar
syuilo committed
[travis-badge]:       http://img.shields.io/travis/syuilo/misskey/master.svg?style=flat-square
syuilo's avatar
syuilo committed
[dependencies-link]:  https://david-dm.org/syuilo/misskey
[dependencies-badge]: https://img.shields.io/david/syuilo/misskey.svg?style=flat-square
syuilo's avatar
syuilo committed
[himasaku]:           https://himasaku.net
[himawari-badge]:     https://img.shields.io/badge/%E5%8F%A4%E8%B0%B7-%E5%90%91%E6%97%A5%E8%91%B5-1684c5.svg?style=flat-square
[sakurako-badge]:     https://img.shields.io/badge/%E5%A4%A7%E5%AE%A4-%E6%AB%BB%E5%AD%90-efb02a.svg?style=flat-square
syuilo's avatar
syuilo committed

syuilo's avatar
syuilo committed
<!-- Contributors Info -->
syuilo's avatar
syuilo committed
[syuilo-link]:      https://syuilo.com
[syuilo-icon]:      https://avatars2.githubusercontent.com/u/4439005?v=3&s=70
syuilo's avatar
syuilo committed
[ayamorisawa-link]: https://github.com/ayamorisawa
[ayamorisawa-icon]: https://avatars0.githubusercontent.com/u/10798641?v=3&s=70
[otofune-link]:     https://github.com/otofune
[otofune-icon]:     https://avatars0.githubusercontent.com/u/15062473?v=3&s=70
syuilo's avatar
syuilo committed
[akihikodaki-link]: https://github.com/akihikodaki
[akihikodaki-icon]: https://avatars2.githubusercontent.com/u/17036990?s=70&v=4
syuilo's avatar
syuilo committed
[rinsuki-link]:     https://github.com/rinsuki
[rinsuki-icon]:     https://avatars0.githubusercontent.com/u/6533808?s=70&v=4