misskey/README.md

206 lines
15 KiB
Markdown
Raw Normal View History

2019-04-07 23:11:03 -07: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 06:37:09 -07:00
[![Misskey](/assets/title.png)](https://misskey.io/)
2017-05-17 22:56:23 -07:00
================================================================
2017-02-22 03:19:34 -08:00
2019-02-08 20:35:04 -08: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 01:41:07 -08:00
**A forever evolving, sophisticated microblogging platform.**
2018-03-28 07:04:06 -07:00
2018-11-07 22:47:10 -08:00
<p align="justify">
<a href="https://misskey.io">Misskey</a> is a decentralized microblogging platform born on Earth.
2018-08-17 12:26:42 -07: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://joinmisskey.github.io/">Find an instance!</a>
2018-11-07 22:47:10 -08:00
</p>
2016-12-28 14:49:51 -08:00
2018-04-18 03:30:24 -07: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-24 21:47:22 -07:00
![](https://ja.mstdn.wiki/images/e/ed/Deck.jpg)
2018-06-07 17:08:09 -07:00
2018-03-28 19:13:40 -07:00
:sparkles: Features
2017-05-17 22:56:23 -07:00
----------------------------------------------------------------
2018-09-12 13:35:11 -07:00
<img src="/assets/about/post.png" align="left" height="200px"/>
<h3 align="left">Posting</h3>
2018-11-07 22:47:10 -08: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 13:35:11 -07:00
</p>
---
<img src="/assets/about/reaction.png" align="right" height="200px"/>
<h3 align="right">Reactions</h3>
2018-11-07 22:47:10 -08: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 13:35:11 -07:00
</p>
---
<img src="/assets/about/ui.png" align="left" height="200px"/>
<h3 align="left">Interface</h3>
2018-11-07 22:47:10 -08: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 13:35:11 -07:00
</p>
---
<img src="/assets/about/drive.png" align="right" width="300px"/>
<h3 align="right">Misskey Drive</h3>
2018-11-07 22:47:10 -08: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 13:35:11 -07:00
</p>
---
2016-12-30 21:11:31 -08:00
2019-04-14 10:45:16 -07: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-30 21:11:31 -08:00
2019-02-19 03:09:33 -08: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 07:13:31 -08:00
:new: What's new
----------------------------------------------------------------
Please see the [Release notes](./CHANGELOG.md).
:package: Create your own instance
2017-05-17 22:56:23 -07:00
----------------------------------------------------------------
Please see the [Setup and Installation Guide](./docs/setup.en.md).
2017-01-23 01:25:52 -08:00
2018-09-01 02:02:04 -07:00
:wrench: Contribution
2018-04-15 13:04:56 -07:00
----------------------------------------------------------------
Please see the [Contribution Guide](./CONTRIBUTING.md).
2018-04-15 13:04:56 -07:00
2019-01-20 22:40:58 -08: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-20 22:40:58 -08: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-20 22:40:58 -08:00
</tr>
</table>
2019-02-03 08:51:01 -08:00
:heart: Backers
2017-05-17 22:56:23 -07:00
----------------------------------------------------------------
2018-08-17 12:34:44 -07:00
<!-- PATREON_START -->
2018-08-17 19:02:58 -07:00
<table><tr>
2019-04-14 01:12:49 -07:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/5888816/36da0f7c15954df0ab13f9abdf227f66/1.jpeg?token-time=2145916800&token-hash=at8QpJXJ8C0zINY_NmoMKv-MhXVoUK-YzTgaJPJzJYU%3D" alt="Hiroshi Seki" width="100"></td>
2019-04-23 08:34:48 -07: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-05-07 04:55:37 -07: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-05-27 07:44:44 -07:00
<td><img src="https://c8.patreon.com/2/200/776209" alt="Denshi" width="100"></td>
2019-06-01 04:38:46 -07:00
<td><img src="https://c8.patreon.com/2/200/557245" alt="mkatze" width="100"></td>
2019-04-14 01:18:55 -07:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/13099460/43cecdbaa63a40d79bf50a96b9910b9d/1.jpe?token-time=2145916800&token-hash=bqwLTk0Wo0hUJJ8J5y7ii05bLzz-_CDA7Bo0Mp4RFU0%3D" alt="ne_moni" width="100"></td>
2019-04-14 01:12:49 -07:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/12913507/f7181eacafe8469a93033d85f5969c29/4.jpe?token-time=2145916800&token-hash=zEyJqVM7u9d8Ri-65fJYSJcWF1jBH1nJ5a3taRzrTmw%3D" alt="Melilot" width="100"></td>
<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>
2018-08-17 19:02:58 -07:00
</tr><tr>
2019-03-22 03:01:29 -07:00
<td><a href="https://www.patreon.com/rane_hs">Hiroshi Seki</a></td>
2019-04-23 08:34:48 -07:00
<td><a href="https://www.patreon.com/weepjp">weepjp</a></td>
2019-05-07 04:55:37 -07:00
<td><a href="https://www.patreon.com/user?u=19045173">kiritan</a></td>
2019-05-27 07:44:44 -07:00
<td><a href="https://www.patreon.com/user?u=776209">Denshi</a></td>
2019-06-01 04:38:46 -07:00
<td><a href="https://www.patreon.com/user?u=557245">mkatze</a></td>
2019-04-14 01:18:55 -07:00
<td><a href="https://www.patreon.com/user?u=13099460">ne_moni</a></td>
2018-12-01 14:05:22 -08:00
<td><a href="https://www.patreon.com/user?u=12913507">Melilot</a></td>
2019-04-05 20:47:02 -07:00
<td><a href="https://www.patreon.com/osapon">osapon</a></td>
2018-08-17 19:02:58 -07:00
</tr></table>
<table><tr>
2019-06-01 04:38:46 -07:00
<td><img src="https://c8.patreon.com/2/200/16869916" alt="見当かなみ" width="100"></td>
2019-05-02 22:34:41 -07: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-04-14 01:12:49 -07:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/12021162/963128bb8d14476dbd8407943db8f31a/1.png?token-time=2145916800&token-hash=FMV7cPKBD1TU2WTbl1jg6AcdKSvTb2BSFcDhgc-EO8w%3D" alt="gutfuckllc" width="100"></td>
<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-01-06 13:52:56 -08:00
<td><img src="https://c8.patreon.com/2/200/12718187" alt="Peter G." width="100"></td>
2019-04-14 01:12:49 -07:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/13039004/509d0c412eb14ae08d6a812a3054f7d6/1.jpe?token-time=2145916800&token-hash=UQRWf01TwHDV4Cls1K0YAOAjM29ssif7hLVq0ESQ0hs%3D" alt="nemu" width="100"></td>
2019-03-01 15:59:53 -08:00
<td><img src="https://c8.patreon.com/2/200/17866454" alt="sikyosyounin" width="100"></td>
2019-04-14 01:12:49 -07:00
<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-02-15 00:20:17 -08:00
<td><img src="https://c8.patreon.com/2/200/17463605" alt="Sampot" width="100"></td>
2019-04-23 22:56:23 -07: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>
2018-08-17 19:02:58 -07:00
</tr><tr>
2019-06-01 04:38:46 -07:00
<td><a href="https://www.patreon.com/user?u=16869916">見当かなみ</a></td>
2019-05-02 22:34:41 -07:00
<td><a href="https://www.patreon.com/Yuzulia">YuzuRyo61</a></td>
2019-04-03 08:50:33 -07:00
<td><a href="https://www.patreon.com/gutfuckllc">gutfuckllc</a></td>
2018-12-26 08:33:19 -08:00
<td><a href="https://www.patreon.com/mydarkstar">mydarkstar</a></td>
2018-11-26 10:08:08 -08:00
<td><a href="https://www.patreon.com/user?u=12718187">Peter G.</a></td>
2018-10-26 11:47:04 -07:00
<td><a href="https://www.patreon.com/user?u=13039004">nemu</a></td>
2019-03-01 15:59:53 -08:00
<td><a href="https://www.patreon.com/user?u=17866454">sikyosyounin</a></td>
2018-10-31 16:23:11 -07:00
<td><a href="https://www.patreon.com/yukimochi">YUKIMOCHI</a></td>
2019-02-15 00:20:17 -08:00
<td><a href="https://www.patreon.com/user?u=17463605">Sampot</a></td>
2019-04-23 22:56:23 -07:00
<td><a href="https://www.patreon.com/user?u=19356899">sheeta.s</a></td>
2018-08-17 19:02:58 -07:00
</tr></table>
2018-10-26 11:47:04 -07:00
<table><tr>
2019-05-07 04:55:37 -07: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-18 23:37:47 -07: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-06-04 02:19:16 -07:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/17195955/be45e5e14c3e48b2bee0456c84e19df4/4.jpe?token-time=2145916800&token-hash=UslrPVM-8TXOe8AapuNiaFYjcIJgPNcU-fKpGbfGJNI%3D" alt="Damillora" width="100"></td>
2019-04-15 21:07:00 -07:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/16900731/83884b38afc74d4cbe83c30a13b10edd/1.png?token-time=2145916800&token-hash=R5Tog8RWg0rguRoCIoir3lThokrdPvs8Utfikhc0nhY%3D" alt="Atsuko Tominaga" width="100"></td>
2019-04-14 01:18:55 -07: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>
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/13034746/c711c7f58e204ecfbc2fd646bc8a4eee/1.jpe?token-time=2145916800&token-hash=EWxXhVbZYH7KB4IDT3joc8TbIg8zPO40x1r5IDn3R7c%3D" alt="Hiratake" width="100"></td>
2019-05-13 02:03:29 -07: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>
2019-05-02 03:44:59 -07:00
<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>
2019-04-14 01:18:55 -07:00
<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-18 23:08:16 -07:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/10789744/97175095d8f04c0f86225ff47cb98d40/1.jpeg?token-time=2145916800&token-hash=l4AoMR7Nj7K4yAHrkrk2hAoggPkbSPm12m1nmbe9Pb8%3D" alt="Naoki Hirayama" width="100"></td>
2018-10-26 11:47:04 -07:00
</tr><tr>
2019-05-07 04:55:37 -07:00
<td><a href="https://www.patreon.com/user?u=13737140">Satsuki Yanagi</a></td>
2019-04-18 23:37:47 -07:00
<td><a href="https://www.patreon.com/takimura">takimura</a></td>
2019-06-04 02:19:16 -07:00
<td><a href="https://www.patreon.com/damillora">Damillora</a></td>
2019-04-01 08:25:14 -07:00
<td><a href="https://www.patreon.com/user?u=16900731">Atsuko Tominaga</a></td>
2019-02-28 21:46:48 -08:00
<td><a href="https://www.patreon.com/user?u=4389829">natalie</a></td>
2019-02-28 18:13:07 -08:00
<td><a href="https://www.patreon.com/hiratake">Hiratake</a></td>
2019-05-13 02:03:29 -07:00
<td><a href="https://www.patreon.com/noellabo">noellabo</a></td>
2019-05-02 03:44:59 -07:00
<td><a href="https://www.patreon.com/Corset">CG</a></td>
2019-03-11 17:50:42 -07:00
<td><a href="https://www.patreon.com/hekovic">Hekovic</a></td>
2019-05-18 23:08:16 -07:00
<td><a href="https://www.patreon.com/spinlock">Naoki Hirayama</a></td>
2018-10-26 11:47:04 -07:00
</tr></table>
2019-04-14 01:18:55 -07:00
<table><tr>
2019-05-27 07:15:46 -07: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-07 04:55:37 -07:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/619786/32cf01444db24e578cd1982c197f6fc6/1.jpeg?token-time=2145916800&token-hash=d8jBQLMOHD87KtXs5C9fk1o58DMF73pQ-dYH3uZJPBE%3D" alt="Gargron" width="100"></td>
2019-05-02 03:44:59 -07: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-04-18 23:37:47 -07: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 01:18:55 -07:00
</tr><tr>
2019-05-27 07:15:46 -07:00
<td><a href="https://www.patreon.com/dansup">dansup</a></td>
2019-05-07 04:55:37 -07:00
<td><a href="https://www.patreon.com/mastodon">Gargron</a></td>
2019-05-02 03:44:59 -07:00
<td><a href="https://www.patreon.com/takenoko">Nokotaro Takeda</a></td>
2019-04-18 23:37:47 -07:00
<td><a href="https://www.patreon.com/user?u=12531784">Takashi Shibuya</a></td>
2019-04-14 01:18:55 -07:00
</tr></table>
2018-08-17 19:02:58 -07:00
2019-06-04 02:19:16 -07:00
**Last updated:** Tue, 04 Jun 2019 04:21:06 UTC
2018-08-17 12:34:44 -07:00
<!-- PATREON_END -->
2018-04-15 22:58:18 -07:00
2018-03-28 19:13:40 -07:00
:four_leaf_clover: Copyright
2017-05-17 22:56:23 -07:00
----------------------------------------------------------------
2018-12-31 07:11:07 -08:00
> Copyright (c) 2014-2019 syuilo
2018-03-28 07:01:42 -07:00
Misskey is open-source software licensed under the [GNU AGPLv3](LICENSE).
2018-03-25 04:19:32 -07:00
2018-04-01 03:43:27 -07:00
[![][agpl-3.0-badge]][AGPL-3.0]
2018-03-25 04:19:32 -07:00
[agpl-3.0]: https://www.gnu.org/licenses/agpl-3.0.en.html
2018-12-16 00:24:52 -08:00
[agpl-3.0-badge]: https://img.shields.io/badge/license-AGPL--3.0-444444.svg?style=for-the-badge
2017-03-01 00:02:07 -08:00
2018-04-14 08:02:16 -07:00
[backer-url]: #backers
2018-04-14 15:14:00 -07:00
[backer-badge]: https://opencollective.com/misskey/backers/badge.svg
2018-04-14 08:02:16 -07:00
[backers-image]: https://opencollective.com/misskey/backers.svg
2018-04-14 15:14:00 -07:00
[sponsor-url]: #sponsors
[sponsor-badge]: https://opencollective.com/misskey/sponsors/badge.svg
[sponsors-image]: https://opencollective.com/misskey/sponsors.svg
2018-04-14 08:02:16 -07:00
[support-url]: https://opencollective.com/misskey#support
2017-03-01 00:02:07 -08:00
[syuilo-link]: https://syuilo.com
[syuilo-icon]: https://avatars2.githubusercontent.com/u/4439005?v=3&s=70