misskey/README.md

141 lines
8.9 KiB
Markdown
Raw Normal View History

2018-09-08 07:30:29 -07:00
<img src="https://github.com/syuilo/misskey/blob/develop/assets/ai-orig.png?raw=true" align="right" height="320px"/>
2018-03-28 06:37:09 -07:00
2018-04-01 19:55:57 -07:00
[![Misskey](/assets/title.png)](https://misskey.xyz/)
2017-05-17 22:56:23 -07:00
================================================================
2017-02-22 03:19:34 -08:00
2016-12-28 14:49:51 -08:00
[![][travis-badge]][travis-link]
[![][dependencies-badge]][dependencies-link]
2018-10-24 02:56:15 -07:00
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
2017-01-24 01:41:07 -08:00
2018-09-08 07:34:51 -07:00
**Sophisticated microblogging platform, evolving forever.**
2018-03-28 07:04:06 -07:00
2018-08-17 12:26:42 -07:00
[Misskey](https://misskey.xyz) is a decentralized microblogging platform born on Earth.
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-09-12 13:39:12 -07:00
Why don't you take a short break from the hustle and bustle of the city, and dive into a new Internet? [Find instance!](https://joinmisskey.github.io/)
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>
<p align="left">
Just post your idea, hot topics and anything you want to share. You may want to decorate your words, attach your favorite pictures, send files including movies and create a poll - those are the things you can do on Misskey!
</p>
---
<img src="/assets/about/reaction.png" align="right" height="200px"/>
<h3 align="right">Reactions</h3>
<p align="right">
Easiest way to tell your emotions. Misskey allows you to add various type of reactions to others post. The emotional experience on Misskey will never be on other SNSs which only able to push “likes”.
</p>
---
<img src="/assets/about/ui.png" align="left" height="200px"/>
<h3 align="left">Interface</h3>
<p align="left">
No UI fits for everyone. Therefore, Misskey has a highly customizable UI for your taste. You can edit layouts of your timeline, place selectable widgets you can easily move and create your unique home as this place will be your home.
</p>
---
<img src="/assets/about/drive.png" align="right" width="300px"/>
<h3 align="right">Misskey Drive</h3>
<p align="right">
Wanna post a picture you have already uploaded? Wish to organize, name and create a folder for your uploaded files? Misskey Drive is the best solution for you. Very easy to share your files online.
</p>
---
2016-12-30 21:11:31 -08:00
2018-09-12 13:39:12 -07:00
and more! You can see it with your own eyes at [misskey.xyz](https://misskey.xyz) or [other instances](https://joinmisskey.github.io/).
2016-12-30 21:11:31 -08:00
2018-08-17 12:26:42 -07:00
:package: Create your own instance
2017-05-17 22:56:23 -07:00
----------------------------------------------------------------
2018-09-01 02:02:04 -07:00
Please see [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
----------------------------------------------------------------
2018-09-01 02:02:04 -07:00
Please see [Contribution guide](./CONTRIBUTING.md).
2018-04-15 13:04:56 -07:00
2018-04-14 15:14:00 -07:00
:heart: Backers & Sponsors
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>
<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-10-02 04:23:27 -07: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-08-17 19:02:58 -07: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>
2018-10-26 11:47:04 -07: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-08-17 19:02:58 -07:00
<td><img src="https://c8.patreon.com/2/100/12718187" alt="Peter G."></td>
</tr><tr>
2018-10-02 04:23:27 -07:00
<td><a href="https://www.patreon.com/negao">negao</a></td>
2018-08-17 19:02:58 -07:00
<td><a href="https://www.patreon.com/user?u=12913507">Melilot</a></td>
<td><a href="https://www.patreon.com/user?u=3384329">べすれい</a></td>
<td><a href="https://www.patreon.com/gutfuckllc">gutfuckllc</a></td>
2018-10-26 11:47:04 -07:00
<td><a href="https://www.patreon.com/mydarkstar">mydarkstar</a></td>
2018-08-17 19:02:58 -07:00
<td><a href="https://www.patreon.com/user?u=12718187">Peter G.</a></td>
</tr></table>
<table><tr>
2018-10-26 11:47:04 -07: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-08-21 22:25:06 -07:00
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/5881381/6235ca5d3fb04c8e95ef5b4ff2abcc18/2?token-time=2145916800&token-hash=zElv7ZcPL3viGsXbNG_KWiKrbV0vvw1gk0panx8DJoo%3D" alt="Naoki Kosaka"></td>
2018-10-26 11:47:04 -07: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 03:03:01 -07: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-26 11:47:04 -07: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-17 19:02:58 -07: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-10-26 11:47:04 -07: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>
<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-08-17 19:02:58 -07: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>
</tr><tr>
2018-10-26 11:47:04 -07:00
<td><a href="https://www.patreon.com/user?u=13039004">nemu</a></td>
2018-08-21 22:25:06 -07:00
<td><a href="https://www.patreon.com/user?u=5881381">Naoki Kosaka</a></td>
2018-10-26 11:47:04 -07:00
<td><a href="https://www.patreon.com/acid_chicken">Acid Chicken</a></td>
2018-08-20 03:03:01 -07:00
<td><a href="https://www.patreon.com/hiratake">Hiratake</a></td>
2018-10-26 11:47:04 -07:00
<td><a href="https://www.patreon.com/spinlock">Naoki Hirayama</a></td>
2018-08-17 19:02:58 -07:00
<td><a href="https://www.patreon.com/dansup">dansup</a></td>
2018-10-26 11:47:04 -07:00
<td><a href="https://www.patreon.com/mastodon">Gargron</a></td>
<td><a href="https://www.patreon.com/takenoko">Nokotaro Takeda</a></td>
2018-08-17 19:02:58 -07:00
<td><a href="https://www.patreon.com/user?u=12531784">Takashi Shibuya</a></td>
</tr></table>
2018-10-26 11:47:04 -07:00
<table><tr>
</tr><tr>
</tr></table>
2018-08-17 19:02:58 -07:00
2018-10-26 21:36:06 -07:00
**Last updated:** Sat, 27 Oct 2018 04:36: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-03-28 07:01:42 -07:00
> Copyright (c) 2014-2018 syuilo
2018-07-07 12:43:07 -07:00
Misskey is an 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
[agpl-3.0-badge]: https://img.shields.io/badge/license-AGPL--3.0-444444.svg?style=flat-square
2016-12-28 14:49:51 -08:00
[travis-link]: https://travis-ci.org/syuilo/misskey
2017-02-26 08:46:43 -08:00
[travis-badge]: http://img.shields.io/travis/syuilo/misskey/master.svg?style=flat-square
2017-11-22 18:47:19 -08:00
[dependencies-link]: https://david-dm.org/syuilo/misskey
[dependencies-badge]: https://img.shields.io/david/syuilo/misskey.svg?style=flat-square
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