1
0
forked from mirror/misskey
misskey/README.md

145 lines
9.6 KiB
Markdown
Raw Normal View History

2018-09-08 23:30:29 +09:00
<img src="https://github.com/syuilo/misskey/blob/develop/assets/ai-orig.png?raw=true" align="right" height="320px"/>
2018-03-28 22:37:09 +09:00
2018-04-02 11:55:57 +09:00
[![Misskey](/assets/title.png)](https://misskey.xyz/)
2017-05-18 14:56:23 +09:00
================================================================
2017-02-22 20:19:34 +09:00
2018-12-16 17:24:52 +09:00
[![CircleCI](https://img.shields.io/circleci/project/github/syuilo/misskey.svg?style=for-the-badge)](https://circleci.com/gh/syuilo/misskey)
[![Dependencies](https://img.shields.io/david/syuilo/misskey.svg?style=for-the-badge)](https://david-dm.org/syuilo/misskey)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge)](http://makeapullrequest.com)
2017-01-24 18:41:07 +09:00
2018-09-08 23:34:51 +09:00
**Sophisticated microblogging platform, evolving forever.**
2018-03-28 23:04:06 +09:00
2018-11-08 15:47:10 +09:00
<p align="justify">
<a href="https://misskey.xyz">Misskey</a> is a decentralized microblogging platform born on Earth.
2018-08-18 04:26:42 +09:00
Since it exists within the Fediverse (a universe where various social media platforms are organized),
it is mutually linked with other social media platforms.
2018-11-08 15:47:10 +09:00
Why don't you take a short break from the hustle and bustle of the city, and dive into a new Internet? <a href="https://joinmisskey.github.io/">Find instance!</a>
</p>
2016-12-29 07:49:51 +09:00
2018-04-18 19:30:24 +09:00
<a href="https://www.patreon.com/syuilo"><img src="https://c5.patreon.com/external/logo/become_a_patron_button@2x.png" alt="Become a Patron!" width="160" /></a>
2018-06-25 13:47:22 +09:00
![](https://ja.mstdn.wiki/images/e/ed/Deck.jpg)
2018-06-08 09:08:09 +09:00
2018-03-29 11:13:40 +09:00
:sparkles: Features
2017-05-18 14:56:23 +09:00
----------------------------------------------------------------
2018-09-13 05:35:11 +09:00
<img src="/assets/about/post.png" align="left" height="200px"/>
<h3 align="left">Posting</h3>
2018-11-08 15:47:10 +09:00
<p align="justify">
2018-11-08 15:19:14 +09:00
Just post your idea, hot topics and anything you want to share. You may decorate your words, attach your favorite pictures or movies, and create a poll - those are all supported in Misskey!
2018-09-13 05:35:11 +09:00
</p>
---
<img src="/assets/about/reaction.png" align="right" height="200px"/>
<h3 align="right">Reactions</h3>
2018-11-08 15:47:10 +09:00
<p align="justify">
2018-11-08 15:19:14 +09:00
The simplest way to tell your emotions to the posts. You can choose the best reaction from various reactions. Reactions on Misskey has much more expressive than other social media which only allows pushing “likes”.
2018-09-13 05:35:11 +09:00
</p>
---
<img src="/assets/about/ui.png" align="left" height="200px"/>
<h3 align="left">Interface</h3>
2018-11-08 15:47:10 +09:00
<p align="justify">
2018-11-08 15:19:14 +09:00
Highly customizable UI for your taste. We understand no UI fits for everyone. Make your graceful home by editing, adjusting layouts of timeline, and placing widgets.
2018-09-13 05:35:11 +09:00
</p>
---
<img src="/assets/about/drive.png" align="right" width="300px"/>
<h3 align="right">Misskey Drive</h3>
2018-11-08 15:47:10 +09:00
<p align="justify">
2018-11-08 15:19:14 +09:00
Organized uploaded files. Wanna post a picture you have already uploaded? Wish to create a folder for your files? Misskey Drive is the best solution for you.
2018-09-13 05:35:11 +09:00
</p>
---
2016-12-31 14:11:31 +09:00
2018-11-08 15:19:14 +09:00
and more! Now it's time to experience the world with your own eyes at [misskey.xyz](https://misskey.xyz) or [other instances](https://joinmisskey.github.io/).
2016-12-31 14:11:31 +09:00
2018-08-18 04:26:42 +09:00
:package: Create your own instance
2017-05-18 14:56:23 +09:00
----------------------------------------------------------------
2018-09-01 18:02:04 +09:00
Please see [Setup and installation guide](./docs/setup.en.md).
2017-01-23 18:25:52 +09:00
2018-09-01 18:02:04 +09:00
:wrench: Contribution
2018-04-16 05:04:56 +09:00
----------------------------------------------------------------
2018-09-01 18:02:04 +09:00
Please see [Contribution guide](./CONTRIBUTING.md).
2018-04-16 05:04:56 +09:00
2018-04-15 07:14:00 +09:00
:heart: Backers & Sponsors
2017-05-18 14:56:23 +09:00
----------------------------------------------------------------
2018-08-18 04:34:44 +09:00
<!-- PATREON_START -->
2018-08-18 11:02:58 +09:00
<table><tr>
2018-11-27 03:08:08 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/12190916/fb7fa7983c14425f890369535b1506a4/1?token-time=2145916800&token-hash=Zeh1u6l_Vmgoy8A1eT1Sltea-_SZSq8t8uOWDRZRh94%3D" alt="weep"></td>
2018-11-27 15:49:39 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/13376668/71f3cf87ec6c4393a44b1b9df5ee3d12/1?token-time=2145916800&token-hash=7pSmWqgMfMSJHVIEcNsuuQoKeU3TRluew5p0EGTzWA4%3D" alt="Arctic"></td>
2018-08-18 11:02:58 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/12731202/0995c46cdcb54153ab5f073f5869b70a/1?token-time=2145916800&token-hash=Yd60FK_SWfQO56SeiJpy1tDHOnCV4xdEywQe8gn5_Wo%3D" alt="negao"></td>
2018-12-02 07:05:22 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/12913507/f7181eacafe8469a93033d85f5969c29/2?token-time=2145916800&token-hash=mgPdX9TqZxEg4TTPuc477dxhIgYk9246qafjWZEqZ7g%3D" alt="Melilot"></td>
2018-12-17 03:31:19 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/12999811/5f349fafcce44dd1824a8b1ebbec4564/3?token-time=2145916800&token-hash=ybYtxfpte1b-rGg6Zecpys2ZdZDtwR_UNJHQjt-3eoU%3D" alt="Xeltica"></td>
2018-08-18 11:02:58 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/3384329/8b713330cb27404ea6e9fac50ff96efe/1?token-time=2145916800&token-hash=0eu4-m1gTWA9PhptVZt6rdKcusqcD7RB87rJT23VVFI%3D" alt="べすれい"></td>
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/12021162/963128bb8d14476dbd8407943db8f31a/1?token-time=2145916800&token-hash=GgJ_NmUB6_nnRNLVGUWjV-WX91On7BOu59LKncYV9fE%3D" alt="gutfuckllc"></td>
</tr><tr>
2018-11-27 03:08:08 +09:00
<td><a href="https://www.patreon.com/weepjp">weep</a></td>
2018-11-27 15:49:39 +09:00
<td><a href="https://www.patreon.com/user?u=13376668">Arctic</a></td>
2018-10-02 20:23:27 +09:00
<td><a href="https://www.patreon.com/negao">negao</a></td>
2018-12-02 07:05:22 +09:00
<td><a href="https://www.patreon.com/user?u=12913507">Melilot</a></td>
2018-12-17 17:26:02 +09:00
<td><a href="https://www.patreon.com/Xeltica">Xeltica</a></td>
2018-08-18 11:02:58 +09:00
<td><a href="https://www.patreon.com/user?u=3384329">べすれい</a></td>
<td><a href="https://www.patreon.com/gutfuckllc">gutfuckllc</a></td>
</tr></table>
<table><tr>
2018-12-27 01:33:19 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/11357794/923ce94cd8c44ba788ee931907881839/1?token-time=2145916800&token-hash=I8lJVM8LeW6TSo5W6uIIRZ42cw83zp1wK_FsbzY0mcQ%3D" alt="mydarkstar"></td>
2018-11-27 03:08:08 +09:00
<td><img src="https://c8.patreon.com/2/100/12718187" alt="Peter G."></td>
2018-10-27 03:47:04 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/13039004/509d0c412eb14ae08d6a812a3054f7d6/1?token-time=2145916800&token-hash=zwSu01tOtn5xTUucDZHuPsCxF2HBEMVs9ROJKTlEV_o%3D" alt="nemu"></td>
2018-11-01 08:23:11 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/5881381/6235ca5d3fb04c8e95ef5b4ff2abcc18/3?token-time=2145916800&token-hash=qsdn0-e6yLaLI6hUX9JAkyTR6a5UdnSp7T1foniBvGQ%3D" alt="YUKIMOCHI"></td>
2018-10-27 03:47:04 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/8241184/39e18850e87a449e9c9a71acb3310ebd/2?token-time=2145916800&token-hash=iUXOQzRyJDv3PJxwS7Mjwg1459dzh2trOq6NFtXu_OM%3D" alt="Acid Chicken"></td>
2018-08-20 19:03:01 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/13034746/c711c7f58e204ecfbc2fd646bc8a4eee/1?token-time=2145916800&token-hash=UERBN4OyP7Nh5XwwdDg0N0IE5cD6_qUQMO81Z5Wizso%3D" alt="Hiratake"></td>
2018-10-27 03:47:04 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/10789744/97175095d8f04c0f86225ff47cb98d40/1?token-time=2145916800&token-hash=P4BIzCX2I1CkEP66ottfhsC8Wr6BUSamjA-vq3pLqFI%3D" alt="Naoki Hirayama"></td>
2018-08-18 11:02:58 +09:00
</tr><tr>
2018-12-27 01:33:19 +09:00
<td><a href="https://www.patreon.com/mydarkstar">mydarkstar</a></td>
2018-11-27 03:08:08 +09:00
<td><a href="https://www.patreon.com/user?u=12718187">Peter G.</a></td>
2018-10-27 03:47:04 +09:00
<td><a href="https://www.patreon.com/user?u=13039004">nemu</a></td>
2018-11-01 08:23:11 +09:00
<td><a href="https://www.patreon.com/yukimochi">YUKIMOCHI</a></td>
2018-10-27 03:47:04 +09:00
<td><a href="https://www.patreon.com/acid_chicken">Acid Chicken</a></td>
2018-08-20 19:03:01 +09:00
<td><a href="https://www.patreon.com/hiratake">Hiratake</a></td>
2018-10-27 03:47:04 +09:00
<td><a href="https://www.patreon.com/spinlock">Naoki Hirayama</a></td>
2018-08-18 11:02:58 +09:00
</tr></table>
2018-10-27 03:47:04 +09:00
<table><tr>
2018-12-27 01:33:19 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/4503830/ccf2cc867ea64de0b524bb2e24b9a1cb/1?token-time=2145916800&token-hash=S1zP0QyLU52Dqq6dtc9qNYyWfW86XrYHiR4NMbeOrnA%3D" alt="dansup"></td>
2018-11-27 15:49:39 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/619786/32cf01444db24e578cd1982c197f6fc6/1?token-time=2145916800&token-hash=tB1e_r8RlZ5sFL0KV_e8dugapxatNBRK1Z3h67TO1g8%3D" alt="Gargron"></td>
2018-11-27 03:08:08 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/5731881/4b6038e6cda34c04b83a5fcce3806a93/1?token-time=2145916800&token-hash=VZUtwrjQa8Jml4twCjHYQQZ64wHEY4oIlGl7Kc-VYUQ%3D" alt="Nokotaro Takeda"></td>
2018-11-23 23:12:54 +09:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/12531784/93a45137841849329ba692da92ac7c60/1?token-time=2145916800&token-hash=tMosUojzUYJCH_3t--tvYA-SMCyrS__hzSndyaRSnbo%3D" alt="Takashi Shibuya"></td>
2018-10-27 03:47:04 +09:00
</tr><tr>
2018-12-27 01:33:19 +09:00
<td><a href="https://www.patreon.com/dansup">dansup</a></td>
2018-11-27 15:49:39 +09:00
<td><a href="https://www.patreon.com/mastodon">Gargron</a></td>
2018-11-27 03:08:08 +09:00
<td><a href="https://www.patreon.com/takenoko">Nokotaro Takeda</a></td>
2018-11-23 23:12:54 +09:00
<td><a href="https://www.patreon.com/user?u=12531784">Takashi Shibuya</a></td>
2018-10-27 03:47:04 +09:00
</tr></table>
2018-08-18 11:02:58 +09:00
2018-12-27 01:33:19 +09:00
**Last updated:** Tue, 25 Dec 2018 04:58:06 UTC
2018-08-18 04:34:44 +09:00
<!-- PATREON_END -->
2018-04-16 14:58:18 +09:00
2018-03-29 11:13:40 +09:00
:four_leaf_clover: Copyright
2017-05-18 14:56:23 +09:00
----------------------------------------------------------------
2018-03-28 23:01:42 +09:00
> Copyright (c) 2014-2018 syuilo
2018-07-08 04:43:07 +09:00
Misskey is an open-source software licensed under the [GNU AGPLv3](LICENSE).
2018-03-25 20:19:32 +09:00
2018-04-01 19:43:27 +09:00
[![][agpl-3.0-badge]][AGPL-3.0]
2018-03-25 20:19:32 +09:00
[agpl-3.0]: https://www.gnu.org/licenses/agpl-3.0.en.html
2018-12-16 17:24:52 +09:00
[agpl-3.0-badge]: https://img.shields.io/badge/license-AGPL--3.0-444444.svg?style=for-the-badge
2017-03-01 17:02:07 +09:00
2018-04-15 00:02:16 +09:00
[backer-url]: #backers
2018-04-15 07:14:00 +09:00
[backer-badge]: https://opencollective.com/misskey/backers/badge.svg
2018-04-15 00:02:16 +09:00
[backers-image]: https://opencollective.com/misskey/backers.svg
2018-04-15 07:14:00 +09:00
[sponsor-url]: #sponsors
[sponsor-badge]: https://opencollective.com/misskey/sponsors/badge.svg
[sponsors-image]: https://opencollective.com/misskey/sponsors.svg
2018-04-15 00:02:16 +09:00
[support-url]: https://opencollective.com/misskey#support
2017-03-01 17:02:07 +09:00
[syuilo-link]: https://syuilo.com
[syuilo-icon]: https://avatars2.githubusercontent.com/u/4439005?v=3&s=70