summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'README.md')
-rw-r--r--README.md53
1 files changed, 24 insertions, 29 deletions
diff --git a/README.md b/README.md
index c50566cc95..ef12958c2f 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,6 @@
-![Misskey](./assets/title.png)
+<img src="https://github.com/syuilo/misskey/blob/b3f42e62af698a67c2250533c437569559f1fdf9/src/himasaku/resources/himasaku.png?raw=true" align="right" width="320px"/>
+
+Misskey
================================================================
[![][travis-badge]][travis-link]
@@ -7,57 +9,46 @@
[![][sakurako-badge]][himasaku]
[![][agpl-3.0-badge]][AGPL-3.0]
-[Misskey](https://misskey.xyz) is a completely open source,
-ultimately sophisticated new type of mini-blog based SNS.
+> Lead Maintainer: [syuilo][syuilo-link]
-![ss](./assets/ss.jpg)
+**[Misskey](https://misskey.xyz)** is a completely open source,
+ultimately sophisticated new type of mini-blog based SNS.
-Key features
+:sparkles: Features
----------------------------------------------------------------
* Automatically updated timeline
* Private messages
* Two-Factor Authentication support
* ServiceWorker support
* Web API for third-party applications
-* No ads
+* ActivityPub compatible
and more! You can touch with your own eyes at https://misskey.xyz/.
-Setup and Installation
+:package: Setup and Installation
----------------------------------------------------------------
If you want to run your own instance of Misskey,
please see [Setup and installation guide](./docs/setup.en.md).
-Contribution
-----------------------------------------------------------------
-Please see [Contribution guide](./CONTRIBUTING.md).
-
-Release Notes
-----------------------------------------------------------------
-Please see [ChangeLog](./CHANGELOG.md).
-
-Sponsors & Backers
+:yen: Donation
----------------------------------------------------------------
-Misskey has no 100+ GitHub stars currently. However, a donation is always welcome!
-If you want to donate to Misskey, please get in touch with [@syuilo][syuilo-link].
+If you want to donate to Misskey, please see [this](./docs/donate.ja.md).
-**Note:** When you donate to Misskey, your name will be listed in [donors](./DONORS.md).
+[List of all donors](./DONORS.md)
-Collaborators
+:mortar_board: Notable contributors
----------------------------------------------------------------
-| ![syuilo][syuilo-icon] | ![Morisawa Aya][ayamorisawa-icon] | ![otofune][otofune-icon] |
-|------------------------|-----------------------------------|---------------------------------|
-| [syuilo][syuilo-link] | [Aya Morisawa][ayamorisawa-link] | [otofune][otofune-link] |
+| ![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] |
[List of all contributors](https://github.com/syuilo/misskey/graphs/contributors)
-Copyright
+:four_leaf_clover: Copyright
----------------------------------------------------------------
-Misskey is an open-source software licensed under [The MIT License](LICENSE).
+> Copyright (c) 2014-2018 syuilo
-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.
+Misskey is an open-source software licensed under [GNU AGPLv3](LICENSE).
[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
@@ -69,10 +60,14 @@ license is applied.) See Git log to identify them.
[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
-<!-- Collaborators Info -->
+<!-- Contributors 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
+[akihikodaki-link]: https://github.com/akihikodaki
+[akihikodaki-icon]: https://avatars2.githubusercontent.com/u/17036990?s=70&v=4
+[rinsuki-link]: https://github.com/rinsuki
+[rinsuki-icon]: https://avatars0.githubusercontent.com/u/6533808?s=70&v=4