misskey/README.md

76 lines
3.8 KiB
Markdown
Raw Normal View History

2018-03-28 06:37:09 -07:00
<img src="https://github.com/syuilo/misskey/blob/b3f42e62af698a67c2250533c437569559f1fdf9/src/himasaku/resources/himasaku.png?raw=true" align="right" width="320px"/>
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-06-20 03:59:57 -07: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 01:41:07 -08:00
2018-03-28 07:04:06 -07:00
> Lead Maintainer: [syuilo][syuilo-link]
**[Misskey](https://misskey.xyz)** is a completely open source,
2018-06-07 21:14:30 -07:00
ultimately sophisticated professional microblogging software.
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-04-13 11:38:55 -07:00
* Reactions
2018-04-26 18:36:05 -07:00
* User lists
2018-07-05 02:18:12 -07:00
* Customizable column view (called MisskeyDeck)
2018-06-08 14:52:33 -07:00
* and widgets!
2017-02-27 01:16:01 -08:00
* Private messages
2018-04-26 18:36:05 -07:00
* Mute
2018-06-20 06:40:02 -07:00
* Real-time timelines
2018-03-27 17:59:36 -07:00
* ActivityPub compatible
2016-12-30 21:11:31 -08:00
2018-05-26 04:43:09 -07:00
and more! You can see it with your own eyes at [misskey.xyz](https://misskey.xyz).
2016-12-30 21:11:31 -08:00
2018-04-14 15:14:00 -07:00
:package: Create your instance
2017-05-17 22:56:23 -07:00
----------------------------------------------------------------
2017-10-22 19:38:32 -07:00
If you want to run your own instance of Misskey,
2017-10-22 00:36:58 -07:00
please see [Setup and installation guide](./docs/setup.en.md).
2017-01-23 01:25:52 -08:00
2018-04-15 13:04:56 -07:00
:wrench: Contribute
----------------------------------------------------------------
2018-04-15 23:10:52 -07:00
**[PR](https://github.com/syuilo/misskey/pulls)s welcome!**
2018-04-15 13:04:56 -07:00
2018-05-15 16:10:01 -07:00
If you want to...
* i18n ... please see [Translation guide](./docs/translate.en.md).
* l10n ... please visit https://crowdin.com/project/misskey
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-07-19 06:15:54 -07:00
| <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"> | <img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/12378075/0156f769e20f412594fa6b87d85fe228/1?token-time=2145916800&token-hash=IsIJRUXszzoD6-7pDnRY8I05T9nSznc4GTaxj7C9SwU%3D"> | <img src="https://c10.patreonusercontent.com/3/eyJoIjoxMDAsInciOjEwMH0%3D/patreon-media/p/user/4503830/ccf2cc867ea64de0b524bb2e24b9a1cb/1?token-time=2145916800&token-hash=S1zP0QyLU52Dqq6dtc9qNYyWfW86XrYHiR4NMbeOrnA%3D"> |
|:-:|:-:|:-:|
| [Gargron](https://www.patreon.com/mastodon) | [39ff](https://www.patreon.com/user/creators?u=12378075) | [dansup](https://www.patreon.com/dansup) |
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