Sharkey/README.md

185 lines
12 KiB
Markdown
Raw Normal View History

2019-03-08 12:52:09 +01:00
<a href="https://ai.misskey.xyz/"><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
2018-04-02 04:55:57 +02:00
[![Misskey](/assets/title.png)](https://misskey.xyz/)
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">
<a href="https://misskey.xyz">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://joinmisskey.github.io/">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
...and more! Experience Misskey with your own eyes at [misskey.xyz](https://misskey.xyz) 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>
</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>
</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-03-22 11:01:29 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/5888816/36da0f7c15954df0ab13f9abdf227f66/1?token-time=2145916800&token-hash=HGkZJ7s4bSaQVoOJ5q30mTWHTxDLiw1LuyaogKPLy24%3D" alt="Hiroshi Seki" width="100"></td>
2019-01-06 22:52:56 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/12190916/fb7fa7983c14425f890369535b1506a4/1?token-time=2145916800&token-hash=WeuDzzz24cRXJogyIkU-mxARqkdyms-rcZKbO-GpGjw%3D" alt="weep" width="100"></td>
2019-02-15 22:58:51 +01:00
<td><img src="https://c8.patreon.com/2/200/12059069" alt="naga_rus" width="100"></td>
2019-03-07 12:30:41 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/12913507/f7181eacafe8469a93033d85f5969c29/4?token-time=2145916800&token-hash=vZdDTTF-ahiKBjjgppS2ev4rkD8H7TTKkXXoxsucs6Y%3D" alt="Melilot" width="100"></td>
2019-01-29 05:42:28 +01:00
<td><img src="https://c8.patreon.com/2/200/16869916" alt="見当かなみ" width="100"></td>
2019-01-06 22:52:56 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/12999811/5f349fafcce44dd1824a8b1ebbec4564/3?token-time=2145916800&token-hash=LtV2lRi3L2jOWMLwccr9qWYfPrFlzIo2jYZHKzHEb6k%3D" alt="Xeltica" width="100"></td>
2018-08-18 04:02:58 +02:00
</tr><tr>
2019-03-22 11:01:29 +01:00
<td><a href="https://www.patreon.com/rane_hs">Hiroshi Seki</a></td>
2018-11-26 19:08:08 +01:00
<td><a href="https://www.patreon.com/weepjp">weep</a></td>
2019-02-15 22:58:51 +01:00
<td><a href="https://www.patreon.com/user?u=12059069">naga_rus</a></td>
2018-12-01 23:05:22 +01:00
<td><a href="https://www.patreon.com/user?u=12913507">Melilot</a></td>
2019-01-29 05:42:28 +01:00
<td><a href="https://www.patreon.com/user?u=16869916">見当かなみ</a></td>
2018-12-17 09:26:02 +01:00
<td><a href="https://www.patreon.com/Xeltica">Xeltica</a></td>
2018-08-18 04:02:58 +02:00
</tr></table>
<table><tr>
2019-04-03 17:50:33 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/12021162/963128bb8d14476dbd8407943db8f31a/1?token-time=2145916800&token-hash=1FlxS9MEgmNGH_RHUVHbO5hIXB5I1z0lvA33CTvYvjA%3D" alt="gutfuckllc" width="100"></td>
2019-01-06 22:52:56 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/11357794/923ce94cd8c44ba788ee931907881839/1?token-time=2145916800&token-hash=0xgcpqvFDqRcV_YIEhcPNVH7gs9sLg_BBnTJXCkN4ao%3D" alt="mydarkstar" width="100"></td>
<td><img src="https://c8.patreon.com/2/200/12718187" alt="Peter G." width="100"></td>
2019-04-01 17:25:14 +02:00
<td><img src="https://c8.patreon.com/2/200/18833336" alt="itiradi" width="100"></td>
2019-01-06 22:52:56 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/13039004/509d0c412eb14ae08d6a812a3054f7d6/1?token-time=2145916800&token-hash=2PsbFNw0tnubZzgSXD01R6hIgncfiElG7H7HX2Y3dyo%3D" alt="nemu" width="100"></td>
2019-03-02 00:59:53 +01:00
<td><img src="https://c8.patreon.com/2/200/17866454" alt="sikyosyounin" width="100"></td>
2019-01-06 22:52:56 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/5881381/6235ca5d3fb04c8e95ef5b4ff2abcc18/3?token-time=2145916800&token-hash=9JtETp0X8gI280Ne1E8bxn6j4Lw5o2k4mJkICx97V_k%3D" alt="YUKIMOCHI" width="100"></td>
2019-02-15 09:20:17 +01:00
<td><img src="https://c8.patreon.com/2/200/17463605" alt="Sampot" width="100"></td>
2019-03-01 06:46:48 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/17880724/311738c8a48f4a6b9443c2445a75adde/1?token-time=2145916800&token-hash=95p8VdGX45E8BitZR_eOcDlqCjumjzNLBPQJrJdeCpI%3D" alt="takimura" width="100"></td>
2019-04-03 05:48:51 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/17195955/be45e5e14c3e48b2bee0456c84e19df4/4?token-time=2145916800&token-hash=SbdZeN5SmsuT9stD6v0jN1z0hftg0FmRiCTxysU0Ihw%3D" alt="Damillora" width="100"></td>
2018-08-18 04:02:58 +02:00
</tr><tr>
2019-04-03 17:50:33 +02:00
<td><a href="https://www.patreon.com/gutfuckllc">gutfuckllc</a></td>
2018-12-26 17:33:19 +01:00
<td><a href="https://www.patreon.com/mydarkstar">mydarkstar</a></td>
2018-11-26 19:08:08 +01:00
<td><a href="https://www.patreon.com/user?u=12718187">Peter G.</a></td>
2019-04-01 17:25:14 +02:00
<td><a href="https://www.patreon.com/user?u=18833336">itiradi</a></td>
2018-10-26 20:47:04 +02:00
<td><a href="https://www.patreon.com/user?u=13039004">nemu</a></td>
2019-03-02 00:59:53 +01:00
<td><a href="https://www.patreon.com/user?u=17866454">sikyosyounin</a></td>
2018-11-01 00:23:11 +01:00
<td><a href="https://www.patreon.com/yukimochi">YUKIMOCHI</a></td>
2019-02-15 09:20:17 +01:00
<td><a href="https://www.patreon.com/user?u=17463605">Sampot</a></td>
2019-03-01 06:46:48 +01:00
<td><a href="https://www.patreon.com/takimura">takimura</a></td>
2019-04-03 05:48:51 +02:00
<td><a href="https://www.patreon.com/damillora">Damillora</a></td>
2018-08-18 04:02:58 +02:00
</tr></table>
2018-10-26 20:47:04 +02:00
<table><tr>
2019-04-01 17:25:14 +02:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/16900731/935a10339daa4ede8e555903a0707060/1?token-time=2145916800&token-hash=3CrpqH-XtKs_NoIlSsTyVs8wCzP1WFCsG2xwps1IJq0%3D" alt="Atsuko Tominaga" width="100"></td>
2019-03-11 00:13:02 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/4389829/9f709180ac714651a70f74a82f3ffdb9/3?token-time=2145916800&token-hash=-iJszBqgYBhsM5qMdA1knf9wvprhEfESzKfR2oh7mIA%3D" alt="natalie" width="100"></td>
2019-03-01 03:13:07 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/13034746/c711c7f58e204ecfbc2fd646bc8a4eee/1?token-time=2145916800&token-hash=5T8XcaAf9Zyzfg3QubR06s_kJZkArVEM2dwObrBVAU4%3D" alt="Hiratake" width="100"></td>
2019-03-12 01:49:58 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/18072312/98e894d960314fa7bc236a72a39488fe/1?token-time=2145916800&token-hash=D6QK3fPyqiYKJfOzc-QqaSSairUrWdjld-ewp2waj6s%3D" alt="Hekovic" width="100"></td>
2019-01-06 22:52:56 +01:00
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/4503830/ccf2cc867ea64de0b524bb2e24b9a1cb/1?token-time=2145916800&token-hash=Ksk_2l3gjPDbnzMUOCSW1E-hdPJsNs2tSR4_RAakRK8%3D" alt="dansup" width="100"></td>
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/619786/32cf01444db24e578cd1982c197f6fc6/1?token-time=2145916800&token-hash=CXe9AqlZy9AsYfiWd3OBYVOzvODoN47Litz0Tu4BFpU%3D" alt="Gargron" width="100"></td>
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/5731881/4b6038e6cda34c04b83a5fcce3806a93/1?token-time=2145916800&token-hash=xhR1n6NAAyEb-IUXLD6_dshkFa3mefU5ZZuk1L8qKTs%3D" alt="Nokotaro Takeda" width="100"></td>
<td><img src="https://c10.patreonusercontent.com/3/eyJ3IjoyMDB9/patreon-media/p/user/12531784/93a45137841849329ba692da92ac7c60/1?token-time=2145916800&token-hash=uR-48MQ0A4j0irQSrCAQZJ-sJUSs_Fkihlg3-l59b7c%3D" alt="Takashi Shibuya" width="100"></td>
2018-10-26 20:47:04 +02:00
</tr><tr>
2019-04-01 17:25:14 +02:00
<td><a href="https://www.patreon.com/user?u=16900731">Atsuko Tominaga</a></td>
2019-03-01 06:46:48 +01:00
<td><a href="https://www.patreon.com/user?u=4389829">natalie</a></td>
2019-03-01 03:13:07 +01:00
<td><a href="https://www.patreon.com/hiratake">Hiratake</a></td>
2019-03-12 01:50:42 +01:00
<td><a href="https://www.patreon.com/hekovic">Hekovic</a></td>
2018-12-26 17:33:19 +01:00
<td><a href="https://www.patreon.com/dansup">dansup</a></td>
2018-11-27 07:49:39 +01:00
<td><a href="https://www.patreon.com/mastodon">Gargron</a></td>
2018-11-26 19:08:08 +01:00
<td><a href="https://www.patreon.com/takenoko">Nokotaro Takeda</a></td>
2018-11-23 15:12:54 +01:00
<td><a href="https://www.patreon.com/user?u=12531784">Takashi Shibuya</a></td>
2018-10-26 20:47:04 +02:00
</tr></table>
2018-08-18 04:02:58 +02:00
2019-04-03 17:50:33 +02:00
**Last updated:** Wed, 03 Apr 2019 15:50:06 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
----------------------------------------------------------------
2018-12-31 16:11:07 +01:00
> Copyright (c) 2014-2019 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