misskey/README.md

104 lines
6.5 KiB
Markdown
Raw Normal View History

2018-03-28 22:37:09 +09:00
<img src="https://github.com/syuilo/misskey/blob/b3f42e62af698a67c2250533c437569559f1fdf9/src/himasaku/resources/himasaku.png?raw=true" align="right" width="320px"/>
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
2016-12-29 07:49:51 +09:00
[![][travis-badge]][travis-link]
[![][dependencies-badge]][dependencies-link]
2018-06-20 19:59:57 +09:00
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com) [![Greenkeeper badge](https://badges.greenkeeper.io/syuilo/misskey.svg)](https://greenkeeper.io/)
2017-01-24 18:41:07 +09:00
2018-08-18 04:26:42 +09:00
Sophisticated microblogging platform, evolving forever.
2018-03-28 23:04:06 +09:00
2018-08-18 04:26:42 +09: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.
Why don't you take a short break from the hustle and bustle of the city, and dive into a new Internet?
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-07-20 06:39:30 +09:00
* Rich text contents
2018-04-14 03:38:55 +09:00
* Reactions
2018-04-27 10:36:05 +09:00
* User lists
2018-07-05 18:18:12 +09:00
* Customizable column view (called MisskeyDeck)
2018-06-09 06:52:33 +09:00
* and widgets!
2017-02-27 18:16:01 +09:00
* Private messages
2018-07-20 06:39:30 +09:00
* ActivityPub support
2016-12-31 14:11:31 +09:00
2018-05-26 20:43:09 +09:00
and more! You can see it with your own eyes at [misskey.xyz](https://misskey.xyz).
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
----------------------------------------------------------------
2017-10-23 11:38:32 +09:00
If you want to run your own instance of Misskey,
2017-10-22 16:36:58 +09:00
please see [Setup and installation guide](./docs/setup.en.md).
2017-01-23 18:25:52 +09:00
2018-04-16 05:04:56 +09:00
:wrench: Contribute
----------------------------------------------------------------
2018-04-16 15:10:52 +09:00
**[PR](https://github.com/syuilo/misskey/pulls)s welcome!**
2018-04-16 05:04:56 +09:00
2018-05-16 08:10:01 +09:00
If you want to...
* i18n ... please see [Translation guide](./docs/translate.en.md).
* l10n ... please visit https://crowdin.com/project/misskey
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-16 00:59:48 +09:00
<table>
<tr>
<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"></td>
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/12378075/0156f769e20f412594fa6b87d85fe228/1?token-time=2145916800&token-hash=IsIJRUXszzoD6-7pDnRY8I05T9nSznc4GTaxj7C9SwU%3D"></td>
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/4503830/ccf2cc867ea64de0b524bb2e24b9a1cb/1?token-time=2145916800&token-hash=S1zP0QyLU52Dqq6dtc9qNYyWfW86XrYHiR4NMbeOrnA%3D"></td>
<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"></td>
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/12959468/c249e15aebec4424b5c0f427173671b6/1?token-time=2145916800&token-hash=lubpCEdxAkxPlpR2O6bvZ7BIh8Q4nGf-U_mE1qpjVAQ%3D"></td>
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/12913507/f7181eacafe8469a93033d85f5969c29/1?token-time=2145916800&token-hash=f03BFb4S2FUx9YEt87TnEmifb4h33OywGBW2akQVtQY%3D"></td>
<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"></td>
<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"></td>
<td><img src="https://c8.patreon.com/2/100/12718187"></td>
<td><img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/12931605/ead494101f364dffa90efe49e36fb494/1?token-time=2145916800&token-hash=NzSFPjIlodXyv41rwK61aZWVZWfI4surJaNj8vWKvqM%3D"></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"></td>
</tr>
<tr>
<td><a href="https://www.patreon.com/mastodon">Gargron</a></td>
<td><a href="https://www.patreon.com/user/creators?u=12378075">39ff</a></td>
<td><a href="https://www.patreon.com/dansup">dansup</a></td>
<td><a href="https://www.patreon.com/user/creators?u=12531784">Takashi Shibuya</a></td>
<td><a href="https://www.patreon.com/fujishan">fujishan</a></td>
<td><a href="https://www.patreon.com/user?u=12913507">Melilot</a></td>
<td><a href="https://www.patreon.com/user?u=5881381">Naoki Kosaka</a></td>
<td><a href="https://www.patreon.com/user?u=12731202">negao</a></td>
<td><a href="https://www.patreon.com/user?u=12718187">Peter G.</a></td>
<td><a href="https://www.patreon.com/user?u=12931605">Reiju</a></td>
<td><a href="https://www.patreon.com/gutfuckllc">gutfuckllc</a></td>
</tr>
</table>
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
[agpl-3.0-badge]: https://img.shields.io/badge/license-AGPL--3.0-444444.svg?style=flat-square
2016-12-29 07:49:51 +09:00
[travis-link]: https://travis-ci.org/syuilo/misskey
2017-02-27 01:46:43 +09:00
[travis-badge]: http://img.shields.io/travis/syuilo/misskey/master.svg?style=flat-square
2017-11-23 11:47:19 +09: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 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