misskey/README.md

204 lines
14 KiB
Markdown
Raw Normal View History

2019-04-08 08:11:03 +02:00
<a href="https://xn--931a.moe/"><img src="https://github.com/syuilo/misskey/blob/develop/assets/ai-orig.png?raw=true" align="right" height="320px"/></a>
2018-03-28 15:37:09 +02:00
2019-11-16 16:15:48 +01:00
[![Misskey](/assets/title.png)](https://join.misskey.page/)
2017-05-18 07:56:23 +02:00
================================================================
2017-02-22 12:19:34 +01:00
2019-02-09 05:35:04 +01:00
[![CircleCI](https://img.shields.io/circleci/project/github/syuilo/misskey.svg?style=for-the-badge&logo=circleci)](https://circleci.com/gh/syuilo/misskey)
[![Dependencies](https://img.shields.io/david/syuilo/misskey.svg?style=for-the-badge&logo=npm)](https://david-dm.org/syuilo/misskey)
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=for-the-badge&logo=github)](http://makeapullrequest.com)
2017-01-24 10:41:07 +01:00
**A forever evolving, sophisticated microblogging platform.**
2018-03-28 16:04:06 +02:00
2018-11-08 07:47:10 +01:00
<p align="justify">
2019-11-16 16:15:48 +01:00
<a href="https://join.misskey.page/">Misskey</a> is a decentralized microblogging platform born on Earth.
2018-08-17 21:26:42 +02: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.
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://join.misskey.page/">Find an instance!</a>
2018-11-08 07:47:10 +01:00
</p>
2016-12-28 23:49:51 +01:00
2018-04-18 12:30:24 +02: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 06:47:22 +02:00
![](https://ja.mstdn.wiki/images/e/ed/Deck.jpg)
2018-06-08 02:08:09 +02:00
2018-03-29 04:13:40 +02:00
:sparkles: Features
2017-05-18 07:56:23 +02:00
----------------------------------------------------------------
2018-09-12 22:35:11 +02:00
<img src="/assets/about/post.png" align="left" height="200px"/>
<h3 align="left">Posting</h3>
2018-11-08 07:47:10 +01:00
<p align="justify">
Post your ideas, discussion topics, fun moments, or anything else you want to share! Misskey supports text, emoji, pictures, videos, and polls!
2018-09-12 22:35:11 +02:00
</p>
---
<img src="/assets/about/reaction.png" align="right" height="200px"/>
<h3 align="right">Reactions</h3>
2018-11-08 07:47:10 +01:00
<p align="justify">
Reactions are the simplest way to respond to others' posts. Simply pick a reaction emote from the list! Reactions on Misskey are much more expressive than other social media services which only allow “liking”.
2018-09-12 22:35:11 +02:00
</p>
---
<img src="/assets/about/ui.png" align="left" height="200px"/>
<h3 align="left">Interface</h3>
2018-11-08 07:47:10 +01:00
<p align="justify">
Customize the UI to your own tastes! No UI will work for everyone, so Misskey is completely customizable. Make Misskey *yours* by editing the style, adjusting timeline layouts, and placing widgets.
2018-09-12 22:35:11 +02:00
</p>
---
<img src="/assets/about/drive.png" align="right" width="300px"/>
<h3 align="right">Misskey Drive</h3>
2018-11-08 07:47:10 +01:00
<p align="justify">
Organize and store your files! Want to post a picture you have already uploaded? Wish you could organize your files into folders? Misskey Drive is a solution!
2018-09-12 22:35:11 +02:00
</p>
---
2016-12-31 06:11:31 +01:00
2019-04-14 19:45:16 +02:00
...and more! Experience Misskey with your own eyes at [misskey.io](https://misskey.io/) or join one of the [other instances](https://joinmisskey.github.io/) that are available.
2016-12-31 06:11:31 +01:00
2019-02-19 12:09:33 +01:00
Screen shots
----------------------------------------------------------------
### Profile page
<img src="/assets/ss/user.jpg" width="500px"/>
### Explore users
<img src="/assets/ss/explore.jpg" width="500px"/>
2019-02-05 16:13:31 +01:00
:new: What's new
----------------------------------------------------------------
Please see the [Release notes](./CHANGELOG.md).
:package: Create your own instance
2017-05-18 07:56:23 +02:00
----------------------------------------------------------------
Please see the [Setup and Installation Guide](./docs/setup.en.md).
2017-01-23 10:25:52 +01:00
2018-09-01 11:02:04 +02:00
:wrench: Contribution
2018-04-15 22:04:56 +02:00
----------------------------------------------------------------
Please see the [Contribution Guide](./CONTRIBUTING.md).
2018-04-15 22:04:56 +02:00
2019-01-21 07:40:58 +01:00
### Collaborators
<table>
<tr>
<td><img src="https://avatars3.githubusercontent.com/u/4439005?s=460&v=4" alt="syuilo" width="100"></td>
<td><img src="https://avatars0.githubusercontent.com/u/10798641?s=460&v=4" alt="AyaMorisawa" width="100"></td>
<td><img src="https://avatars1.githubusercontent.com/u/30769358?s=460&v=4" alt="mei23" width="100"></td>
<td><img src="https://avatars2.githubusercontent.com/u/20679825?s=460&v=4" alt="acid-chicken" width="100"></td>
<td><img src="https://avatars2.githubusercontent.com/u/6533808?s=460&v=4" alt="rinsuki" width="100"></td>
2019-01-21 07:40:58 +01:00
</tr>
<tr>
<td align="center"><a href="https://github.com/syuilo">@syuilo</a></td>
<td align="center"><a href="https://github.com/AyaMorisawa">@AyaMorisawa</a></td>
<td align="center"><a href="https://github.com/mei23">@mei23</a></td>
<td align="center"><a href="https://github.com/acid-chicken">@acid-chicken</a></td>
<td align="center"><a href="https://github.com/rinsuki">@rinsuki</a></td>
2019-01-21 07:40:58 +01:00
</tr>
</table>
2019-02-03 17:51:01 +01:00
:heart: Backers
2017-05-18 07:56:23 +02:00
----------------------------------------------------------------
2018-08-17 21:34:44 +02:00
<!-- PATREON_START -->
2018-08-18 04:02:58 +02:00
<table><tr>
2019-12-10 13:40:42 +01:00
<td><img src="https://c8.patreon.com/2/200/27956229" alt="Oliver Maximilian Seidel" width="100"></td>
2019-04-23 17:34:48 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/12190916/fb7fa7983c14425f890369535b1506a4/3.png?token-time=2145916800&token-hash=oH_i7gJjNT7Ot6j9JiVwy7ZJIBqACVnzLqlz4YrDAZA%3D" alt="weepjp" width="100"></td>
2019-12-10 13:40:42 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/605366/c9dc408fdcbf412fb183ca5b06235f8d/1.jpeg?token-time=2145916800&token-hash=oaqsjLqOFjWN5I9hm2epOaTXaEtKwQUy5OW-EpAz6-g%3D" alt="Jon Leibowitz" width="100"></td>
2019-05-07 13:55:37 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/19045173/cb91c0f345c24d4ebfd05f19906d5e26/1.png?token-time=2145916800&token-hash=o_zKBytJs_AxHwSYw_5R8eD0eSJe3RoTR3kR3Q0syN0%3D" alt="kiritan" width="100"></td>
2019-12-20 01:48:25 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/24430516/b1964ac5b9f746d2a12ff53dbc9aa40a/1.jpg?token-time=2145916800&token-hash=bmEiMGYpp3bS7hCCbymjGGsHBZM3AXuBOFO3Kro37PU%3D" alt="Eduardo Quiros" width="100"></td>
2019-12-11 13:57:49 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/14215107/1cbe1912c26143919fa0faca16f12ce1/2.png?token-time=2145916800&token-hash=v0KzlXjyiq18u6aSxyy9qIUxSCAx-nnHlO7MzhSA6Mc%3D" alt="Nesakko" width="100"></td>
2019-05-27 16:44:44 +02:00
<td><img src="https://c8.patreon.com/2/200/776209" alt="Denshi" width="100"></td>
2018-08-18 04:02:58 +02:00
</tr><tr>
2019-12-10 13:40:42 +01:00
<td><a href="https://www.patreon.com/user?u=27956229">Oliver Maximilian Seidel</a></td>
2019-04-23 17:34:48 +02:00
<td><a href="https://www.patreon.com/weepjp">weepjp</a></td>
2019-12-10 13:40:42 +01:00
<td><a href="https://www.patreon.com/jonleibowitz">Jon Leibowitz</a></td>
2019-05-07 13:55:37 +02:00
<td><a href="https://www.patreon.com/user?u=19045173">kiritan</a></td>
2019-12-20 01:48:25 +01:00
<td><a href="https://www.patreon.com/user?u=24430516">Eduardo Quiros</a></td>
2019-12-11 13:57:49 +01:00
<td><a href="https://www.patreon.com/Nesakko">Nesakko</a></td>
2019-05-27 16:44:44 +02:00
<td><a href="https://www.patreon.com/user?u=776209">Denshi</a></td>
2018-08-18 04:02:58 +02:00
</tr></table>
<table><tr>
2019-12-11 13:57:49 +01:00
<td><img src="https://c8.patreon.com/2/200/557245" alt="mkatze" width="100"></td>
2019-12-10 13:40:42 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/23915207/25428766ecd745478e600b3d7f871eb2/1.png?token-time=2145916800&token-hash=urCLLA4KjJZX92Y1CxcBP4d8bVTHGkiaPnQZp-Tqz68%3D" alt="kabo2468y" width="100"></td>
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/8249688/4aacf36b6b244ab1bc6653591b6640df/2.png?token-time=2145916800&token-hash=1ZEf2w6L34253cZXS_HlVevLEENWS9QqrnxGUAYblPo%3D" alt="AureoleArk" width="100"></td>
2019-07-19 17:40:08 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/5670915/ee175f0bfb6347ffa4ea101a8c097bff/1.jpg?token-time=2145916800&token-hash=mPLM9CA-riFHx-myr3bLZJuH2xBRHA9se5VbHhLIOuA%3D" alt="osapon" width="100"></td>
2019-06-01 13:38:46 +02:00
<td><img src="https://c8.patreon.com/2/200/16869916" alt="見当かなみ" width="100"></td>
2019-05-03 07:34:41 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/18899730/6a22797f68254034a854d69ea2445fc8/1.png?token-time=2145916800&token-hash=b_uj57yxo5VzkSOUS7oXE_762dyOTB_oxzbO6lFNG3k%3D" alt="YuzuRyo61" width="100"></td>
2019-09-07 16:43:35 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/5788159/af42076ab3354bb49803cfba65f94bee/1.jpg?token-time=2145916800&token-hash=iSaxp_Yr2-ZiU2YVi9rcpZZj9mj3UvNSMrZr4CU4qtA%3D" alt="mewl hayabusa" width="100"></td>
2019-04-14 10:12:49 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/11357794/923ce94cd8c44ba788ee931907881839/1.png?token-time=2145916800&token-hash=9nEQje_eMvUjq9a7L3uBqW-MQbS-rRMaMgd7UYVoFNM%3D" alt="mydarkstar" width="100"></td>
2019-10-03 16:44:20 +02:00
<td><img src="https://c8.patreon.com/2/200/16542964" alt="Takumi Sugita" width="100"></td>
2018-08-18 04:02:58 +02:00
</tr><tr>
2019-12-11 13:57:49 +01:00
<td><a href="https://www.patreon.com/user?u=557245">mkatze</a></td>
2019-12-10 13:40:42 +01:00
<td><a href="https://www.patreon.com/user?u=23915207">kabo2468y</a></td>
<td><a href="https://www.patreon.com/AureoleArk">AureoleArk</a></td>
2019-07-19 17:40:08 +02:00
<td><a href="https://www.patreon.com/osapon">osapon</a></td>
2019-06-01 13:38:46 +02:00
<td><a href="https://www.patreon.com/user?u=16869916">見当かなみ</a></td>
2019-05-03 07:34:41 +02:00
<td><a href="https://www.patreon.com/Yuzulia">YuzuRyo61</a></td>
2019-09-07 16:43:35 +02:00
<td><a href="https://www.patreon.com/hs_sh_net">mewl hayabusa</a></td>
2018-12-26 17:33:19 +01:00
<td><a href="https://www.patreon.com/mydarkstar">mydarkstar</a></td>
2019-10-03 16:44:20 +02:00
<td><a href="https://www.patreon.com/user?u=16542964">Takumi Sugita</a></td>
2018-08-18 04:02:58 +02:00
</tr></table>
2018-10-26 20:47:04 +02:00
<table><tr>
2019-12-10 13:40:42 +01:00
<td><img src="https://c8.patreon.com/2/200/17866454" alt="sikyosyounin" width="100"></td>
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/5881381/6235ca5d3fb04c8e95ef5b4ff2abcc18/3.png?token-time=2145916800&token-hash=KjfQL8nf3AIf6WqzLshBYAyX44piAqOAZiYXgZS_H6A%3D" alt="YUKIMOCHI" width="100"></td>
2019-09-07 16:43:35 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/19356899/496b4681d33b4520bd7688e0fd19c04d/2.jpeg?token-time=2145916800&token-hash=_sTj3dUBOhn9qwiJ7F19Qd-yWWfUqJC_0jG1h0agEqQ%3D" alt="sheeta.s" width="100"></td>
2019-12-03 00:53:08 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/5827393/59893c191dda408f9cabd0f20a3a5627/1.jpeg?token-time=2145916800&token-hash=i9N05vOph-eP1LTLb9_npATjYOpntL0ZsHNaZFSsPmE%3D" alt="motcha" width="100"></td>
2019-05-07 13:55:37 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/13737140/1adf7835017d479280d90fe8d30aade2/1.png?token-time=2145916800&token-hash=0pdle8h5pDZrww0BDOjdz6zO-HudeGTh36a3qi1biVU%3D" alt="Satsuki Yanagi" width="100"></td>
2019-04-19 08:37:47 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/17880724/311738c8a48f4a6b9443c2445a75adde/1.jpe?token-time=2145916800&token-hash=CPxGQhKIlEaa6WUcgbyHixyKEhakiw9RFdOhsIJBQ_o%3D" alt="takimura" width="100"></td>
2019-08-02 15:37:31 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/16900731/619ab87cc08448439222631ebb26802f/1.gif?token-time=2145916800&token-hash=o27K7M02s1z-LkDUEO5Oa7cu-GviRXeOXxryi4o_6VU%3D" alt="Atsuko Tominaga" width="100"></td>
2018-10-26 20:47:04 +02:00
</tr><tr>
2019-12-10 13:40:42 +01:00
<td><a href="https://www.patreon.com/user?u=17866454">sikyosyounin</a></td>
<td><a href="https://www.patreon.com/yukimochi">YUKIMOCHI</a></td>
2019-09-07 16:43:35 +02:00
<td><a href="https://www.patreon.com/user?u=19356899">sheeta.s</a></td>
2019-12-03 00:53:08 +01:00
<td><a href="https://www.patreon.com/user?u=5827393">motcha</a></td>
2019-05-07 13:55:37 +02:00
<td><a href="https://www.patreon.com/user?u=13737140">Satsuki Yanagi</a></td>
2019-04-19 08:37:47 +02:00
<td><a href="https://www.patreon.com/takimura">takimura</a></td>
2019-08-02 15:37:31 +02:00
<td><a href="https://www.patreon.com/user?u=16900731">Atsuko Tominaga</a></td>
2018-10-26 20:47:04 +02:00
</tr></table>
2019-04-14 10:18:55 +02:00
<table><tr>
2019-12-30 18:47:33 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/4389829/9f709180ac714651a70f74a82f3ffdb9/3.png?token-time=2145916800&token-hash=FTm3WVom4dJ9NwWMU4OpCL_8Yc13WiwEbKrDPyTZTPs%3D" alt="natalie" width="100"></td>
2019-12-10 13:40:42 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/5923936/2a743cbfbff946c2af3f09026047c0da/2.png?token-time=2145916800&token-hash=h6yphW1qnM0n_NOWaf8qtszMRLXEwIxfk5beu4RxdT0%3D" alt="noellabo" width="100"></td>
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/2384390/5681180e1efb46a8b28e0e8d4c8b9037/1.jpg?token-time=2145916800&token-hash=SJcMy-Q1BcS940-LFUVOMfR7-5SgrzsEQGhYb3yowFk%3D" alt="CG" width="100"></td>
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/18072312/98e894d960314fa7bc236a72a39488fe/1.jpe?token-time=2145916800&token-hash=qA8j97lIZNc-74AuZ0p4F3ms6sKPeKjtNt2vEuwpsyo%3D" alt="Hekovic" width="100"></td>
2019-05-27 16:15:46 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/4503830/ccf2cc867ea64de0b524bb2e24b9a1cb/1.jpeg?token-time=2145916800&token-hash=L55UhJ0rcuNAH3w_ryeeGN4hC6taoOixyAhraEi0bzw%3D" alt="dansup" width="100"></td>
2019-05-02 12:44:59 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/5731881/4b6038e6cda34c04b83a5fcce3806a93/1.png?token-time=2145916800&token-hash=hBayGfOmQH3kRMdNnDe4oCZD_9fsJWSt29xXR3KRMVk%3D" alt="Nokotaro Takeda" width="100"></td>
2019-09-02 18:02:57 +02:00
<td><img src="https://c8.patreon.com/2/200/23932002" alt="nenohi" width="100"></td>
2019-04-19 08:37:47 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/12531784/93a45137841849329ba692da92ac7c60/1.jpeg?token-time=2145916800&token-hash=vGe7wXGqmA8Q7m-kDNb6fyGdwk-Dxk4F-ut8ZZu51RM%3D" alt="Takashi Shibuya" width="100"></td>
2019-04-14 10:18:55 +02:00
</tr><tr>
2019-12-30 18:47:33 +01:00
<td><a href="https://www.patreon.com/user?u=4389829">natalie</a></td>
2019-12-10 13:40:42 +01:00
<td><a href="https://www.patreon.com/noellabo">noellabo</a></td>
<td><a href="https://www.patreon.com/Corset">CG</a></td>
<td><a href="https://www.patreon.com/hekovic">Hekovic</a></td>
2019-05-27 16:15:46 +02:00
<td><a href="https://www.patreon.com/dansup">dansup</a></td>
2019-05-02 12:44:59 +02:00
<td><a href="https://www.patreon.com/takenoko">Nokotaro Takeda</a></td>
2019-09-02 18:02:57 +02:00
<td><a href="https://www.patreon.com/user?u=23932002">nenohi</a></td>
2019-04-19 08:37:47 +02:00
<td><a href="https://www.patreon.com/user?u=12531784">Takashi Shibuya</a></td>
2019-04-14 10:18:55 +02:00
</tr></table>
2018-08-18 04:02:58 +02:00
2019-12-30 18:47:33 +01:00
**Last updated:** Sat, 28 Dec 2019 18:22:07 UTC
2018-08-17 21:34:44 +02:00
<!-- PATREON_END -->
2018-04-16 07:58:18 +02:00
2018-03-29 04:13:40 +02:00
:four_leaf_clover: Copyright
2017-05-18 07:56:23 +02:00
----------------------------------------------------------------
2020-01-01 20:15:16 +01:00
> Copyright (c) 2014-2020 syuilo
2018-03-28 16:01:42 +02:00
Misskey is open-source software licensed under the [GNU AGPLv3](LICENSE).
2018-03-25 13:19:32 +02:00
2018-04-01 12:43:27 +02:00
[![][agpl-3.0-badge]][AGPL-3.0]
2018-03-25 13:19:32 +02:00
[agpl-3.0]: https://www.gnu.org/licenses/agpl-3.0.en.html
2018-12-16 09:24:52 +01:00
[agpl-3.0-badge]: https://img.shields.io/badge/license-AGPL--3.0-444444.svg?style=for-the-badge
2017-03-01 09:02:07 +01:00
2018-04-14 17:02:16 +02:00
[backer-url]: #backers
2018-04-15 00:14:00 +02:00
[backer-badge]: https://opencollective.com/misskey/backers/badge.svg
2018-04-14 17:02:16 +02:00
[backers-image]: https://opencollective.com/misskey/backers.svg
2018-04-15 00:14:00 +02:00
[sponsor-url]: #sponsors
[sponsor-badge]: https://opencollective.com/misskey/sponsors/badge.svg
[sponsors-image]: https://opencollective.com/misskey/sponsors.svg
2018-04-14 17:02:16 +02:00
[support-url]: https://opencollective.com/misskey#support
2017-03-01 09:02:07 +01:00
[syuilo-link]: https://syuilo.com
[syuilo-icon]: https://avatars2.githubusercontent.com/u/4439005?v=3&s=70