misskey/README.md

79 lines
3.4 KiB
Markdown
Raw Normal View History

2017-03-29 16:57:42 -07:00
![Misskey](./assets/title.png)
2017-05-17 22:56:23 -07:00
================================================================
2017-02-22 03:19:34 -08:00
2016-12-28 14:49:51 -08:00
[![][travis-badge]][travis-link]
[![][dependencies-badge]][dependencies-link]
2017-01-24 01:41:07 -08:00
[![][himawari-badge]][himasaku]
[![][sakurako-badge]][himasaku]
2018-03-25 04:19:32 -07:00
[![][agpl-3.0-badge]][AGPL-3.0]
2017-01-24 01:41:07 -08:00
2017-02-22 03:19:34 -08:00
[Misskey](https://misskey.xyz) is a completely open source,
ultimately sophisticated new type of mini-blog based SNS.
2016-12-28 14:49:51 -08:00
2017-03-22 00:19:32 -07:00
![ss](./assets/ss.jpg)
2016-12-29 03:43:33 -08:00
2017-02-22 03:19:34 -08:00
Key features
2017-05-17 22:56:23 -07:00
----------------------------------------------------------------
2016-12-30 21:15:37 -08:00
* Automatically updated timeline
2017-02-27 01:16:01 -08:00
* Private messages
2017-12-09 11:16:20 -08:00
* Two-Factor Authentication support
2017-11-20 15:00:27 -08:00
* ServiceWorker support
2017-03-27 03:00:51 -07:00
* Web API for third-party applications
2017-06-14 05:17:57 -07:00
* No ads
2016-12-30 21:11:31 -08:00
2017-01-02 12:28:54 -08:00
and more! You can touch with your own eyes at https://misskey.xyz/.
2016-12-30 21:11:31 -08:00
2017-05-17 22:56:23 -07:00
Setup and Installation
----------------------------------------------------------------
2017-10-22 19:38:32 -07:00
If you want to run your own instance of Misskey,
2017-10-22 00:36:58 -07:00
please see [Setup and installation guide](./docs/setup.en.md).
2017-01-23 01:25:52 -08:00
2017-03-26 05:32:19 -07:00
Contribution
2017-05-17 22:56:23 -07:00
----------------------------------------------------------------
2017-03-26 05:32:19 -07:00
Please see [Contribution guide](./CONTRIBUTING.md).
2016-12-30 12:35:23 -08:00
2017-08-28 19:42:12 -07:00
Release Notes
----------------------------------------------------------------
Please see [ChangeLog](./CHANGELOG.md).
2017-05-25 19:05:03 -07:00
Sponsors & Backers
----------------------------------------------------------------
2017-11-12 03:24:00 -08:00
Misskey has no 100+ GitHub stars currently. However, a donation is always welcome!
2017-05-25 19:09:19 -07:00
If you want to donate to Misskey, please get in touch with [@syuilo][syuilo-link].
2017-05-25 19:05:03 -07:00
2017-11-12 03:22:37 -08:00
**Note:** When you donate to Misskey, your name will be listed in [donors](./DONORS.md).
2017-08-28 05:25:47 -07:00
Collaborators
----------------------------------------------------------------
| ![syuilo][syuilo-icon] | ![Morisawa Aya][ayamorisawa-icon] | ![otofune][otofune-icon] |
|------------------------|-----------------------------------|---------------------------------|
| [syuilo][syuilo-link] | [Aya Morisawa][ayamorisawa-link] | [otofune][otofune-link] |
[List of all contributors](https://github.com/syuilo/misskey/graphs/contributors)
2017-02-22 03:19:34 -08:00
Copyright
2017-05-17 22:56:23 -07:00
----------------------------------------------------------------
2017-01-19 03:44:19 -08:00
Misskey is an open-source software licensed under [The MIT License](LICENSE).
2016-12-28 14:49:51 -08:00
2018-03-25 04:19:32 -07:00
The portions of Misskey contributed by Akihiko Odaki <nekomanma@pixiv.co.jp> is
licensed under GNU Affero General Public License (only version 3.0 of the
license is applied.) See Git log to identify them.
[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
2016-12-28 14:49:51 -08:00
[travis-link]: https://travis-ci.org/syuilo/misskey
2017-02-26 08:46:43 -08:00
[travis-badge]: http://img.shields.io/travis/syuilo/misskey/master.svg?style=flat-square
2017-11-22 18:47:19 -08:00
[dependencies-link]: https://david-dm.org/syuilo/misskey
[dependencies-badge]: https://img.shields.io/david/syuilo/misskey.svg?style=flat-square
2017-01-24 01:41:07 -08:00
[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
2017-03-01 00:02:07 -08:00
<!-- Collaborators Info -->
[syuilo-link]: https://syuilo.com
[syuilo-icon]: https://avatars2.githubusercontent.com/u/4439005?v=3&s=70
[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