cherrypick/README.md

75 lines
3.2 KiB
Markdown
Raw Normal View History

2017-03-30 08:57:42 +09:00
![Misskey](./assets/title.png)
2017-05-18 14:56:23 +09:00
================================================================
2017-02-22 20:19:34 +09:00
2016-12-29 07:49:51 +09:00
[![][travis-badge]][travis-link]
[![][dependencies-badge]][dependencies-link]
2017-01-24 18:41:07 +09:00
[![][himawari-badge]][himasaku]
[![][sakurako-badge]][himasaku]
2017-02-27 04:02:24 +09:00
[![][mit-badge]][mit]
2017-01-24 18:41:07 +09:00
2017-02-22 20:19:34 +09:00
[Misskey](https://misskey.xyz) is a completely open source,
ultimately sophisticated new type of mini-blog based SNS.
2016-12-29 07:49:51 +09:00
2017-03-22 16:19:32 +09:00
![ss](./assets/ss.jpg)
2016-12-29 20:43:33 +09:00
2017-02-22 20:19:34 +09:00
Key features
2017-05-18 14:56:23 +09:00
----------------------------------------------------------------
2016-12-31 14:15:37 +09:00
* Automatically updated timeline
2017-02-27 18:16:01 +09:00
* Private messages
2017-12-10 04:16:20 +09:00
* Two-Factor Authentication support
2017-11-21 08:00:27 +09:00
* ServiceWorker support
2017-03-27 19:00:51 +09:00
* Web API for third-party applications
2017-06-14 21:17:57 +09:00
* No ads
2016-12-31 14:11:31 +09:00
2017-01-03 05:28:54 +09:00
and more! You can touch with your own eyes at https://misskey.xyz/.
2016-12-31 14:11:31 +09:00
2017-05-18 14:56:23 +09:00
Setup and Installation
----------------------------------------------------------------
2017-10-23 11:38:32 +09:00
If you want to run your own instance of Misskey,
2017-10-22 16:36:58 +09:00
please see [Setup and installation guide](./docs/setup.en.md).
2017-01-23 18:25:52 +09:00
2017-03-26 21:32:19 +09:00
Contribution
2017-05-18 14:56:23 +09:00
----------------------------------------------------------------
2017-03-26 21:32:19 +09:00
Please see [Contribution guide](./CONTRIBUTING.md).
2016-12-31 05:35:23 +09:00
2017-08-29 11:42:12 +09:00
Release Notes
----------------------------------------------------------------
Please see [ChangeLog](./CHANGELOG.md).
2017-05-26 11:05:03 +09:00
Sponsors & Backers
----------------------------------------------------------------
2017-11-12 20:24:00 +09:00
Misskey has no 100+ GitHub stars currently. However, a donation is always welcome!
2017-05-26 11:09:19 +09:00
If you want to donate to Misskey, please get in touch with [@syuilo][syuilo-link].
2017-05-26 11:05:03 +09:00
2017-11-12 20:22:37 +09:00
**Note:** When you donate to Misskey, your name will be listed in [donors](./DONORS.md).
2017-08-28 21:25:47 +09: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 20:19:34 +09:00
Copyright
2017-05-18 14:56:23 +09:00
----------------------------------------------------------------
2017-01-19 20:44:19 +09:00
Misskey is an open-source software licensed under [The MIT License](LICENSE).
2016-12-29 07:49:51 +09:00
[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
2017-02-27 01:46:43 +09:00
[travis-badge]: http://img.shields.io/travis/syuilo/misskey/master.svg?style=flat-square
2017-11-23 11:47:19 +09: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 18:41:07 +09: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 17:02:07 +09: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