Skip to content
Snippets Groups Projects
README.md 2.44 KiB
Newer Older
syuilo's avatar
syuilo committed
![Misskey](./assets/title.png)
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
[![][mit-badge]][mit]
syuilo's avatar
syuilo committed

syuilo's avatar
syuilo committed
[Misskey](https://misskey.xyz) is a completely open source,
ultimately sophisticated new type of mini-blog based SNS.
syuilo's avatar
syuilo committed
![ss](./assets/ss.jpg)
syuilo's avatar
syuilo committed

syuilo's avatar
syuilo committed
Key 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
こぴなたみぽ's avatar
こぴなたみぽ committed
* Free 1GB storage for each all users
syuilo's avatar
syuilo committed
* Machine learning
Aya Morisawa's avatar
Aya Morisawa committed
* Web API for third-party applications
こぴなたみぽ's avatar
こぴなたみぽ committed
* No ads
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
Setup and Installation
----------------------------------------------------------------
syuilo's avatar
syuilo committed
Please see [Setup and installation guide](./docs/setup.en.md).
syuilo's avatar
syuilo committed

Aya Morisawa's avatar
Aya Morisawa committed
Contribution
syuilo's avatar
syuilo committed
----------------------------------------------------------------
Aya Morisawa's avatar
Aya Morisawa committed
Please see [Contribution guide](./CONTRIBUTING.md).
syuilo⭐️'s avatar
syuilo⭐️ committed

こぴなたみぽ's avatar
こぴなたみぽ committed
Release Notes
----------------------------------------------------------------
Please see [ChangeLog](./CHANGELOG.md).

こぴなたみぽ's avatar
こぴなたみぽ committed
Sponsors & Backers
----------------------------------------------------------------
こぴなたみぽ's avatar
こぴなたみぽ committed
Misskey have no 100+ GitHub stars currently. However, donation are always welcome!
If you want to donate to Misskey, please get in touch with [@syuilo][syuilo-link].
こぴなたみぽ's avatar
こぴなたみぽ committed
**Note:** When you donate to Misskey, your name will be displayed in [donors](./DONORS.md).
syuilo's avatar
syuilo committed

syuilo's avatar
syuilo committed
Copyright
syuilo's avatar
syuilo committed
----------------------------------------------------------------
Aya Morisawa's avatar
Aya Morisawa committed
Misskey is an open-source software licensed under [The MIT License](LICENSE).

[mit]:                http://opensource.org/licenses/MIT
[mit-badge]:          https://img.shields.io/badge/license-MIT-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
[dependencies-link]:  https://gemnasium.com/syuilo/misskey
[dependencies-badge]: https://img.shields.io/gemnasium/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

<!-- Collaborators Info -->
[syuilo-link]:      https://syuilo.com
[syuilo-icon]:      https://avatars2.githubusercontent.com/u/4439005?v=3&s=70