Sharkey/README.md

101 lines
4.6 KiB
Markdown
Raw Normal View History

2018-03-28 13:37:09 +00:00
<img src="https://github.com/syuilo/misskey/blob/b3f42e62af698a67c2250533c437569559f1fdf9/src/himasaku/resources/himasaku.png?raw=true" align="right" width="320px"/>
2018-04-02 02:55:57 +00:00
[![Misskey](/assets/title.png)](https://misskey.xyz/)
2017-05-18 05:56:23 +00:00
================================================================
2017-02-22 11:19:34 +00:00
2016-12-28 22:49:51 +00:00
[![][travis-badge]][travis-link]
[![][dependencies-badge]][dependencies-link]
2017-01-24 09:41:07 +00:00
[![][himawari-badge]][himasaku]
[![][sakurako-badge]][himasaku]
2018-04-01 10:43:27 +00:00
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square)](http://makeapullrequest.com)
2017-01-24 09:41:07 +00:00
2018-03-28 14:04:06 +00:00
> Lead Maintainer: [syuilo][syuilo-link]
**[Misskey](https://misskey.xyz)** is a completely open source,
2017-02-22 11:19:34 +00:00
ultimately sophisticated new type of mini-blog based SNS.
2016-12-28 22:49:51 +00:00
2018-03-29 02:13:40 +00:00
:sparkles: Features
2017-05-18 05:56:23 +00:00
----------------------------------------------------------------
2016-12-31 05:15:37 +00:00
* Automatically updated timeline
2018-04-13 18:38:55 +00:00
* Reactions
2017-02-27 09:16:01 +00:00
* Private messages
2017-11-20 23:00:27 +00:00
* ServiceWorker support
2018-03-28 00:59:36 +00:00
* ActivityPub compatible
2016-12-31 05:11:31 +00:00
2017-01-02 20:28:54 +00:00
and more! You can touch with your own eyes at https://misskey.xyz/.
2016-12-31 05:11:31 +00:00
2018-04-14 22:14:00 +00:00
:package: Create your instance
2017-05-18 05:56:23 +00:00
----------------------------------------------------------------
2017-10-23 02:38:32 +00:00
If you want to run your own instance of Misskey,
2017-10-22 07:36:58 +00:00
please see [Setup and installation guide](./docs/setup.en.md).
2017-01-23 09:25:52 +00:00
2018-04-15 20:04:56 +00:00
:wrench: Contribute
----------------------------------------------------------------
2018-04-16 06:10:52 +00:00
**[PR](https://github.com/syuilo/misskey/pulls)s welcome!**
2018-04-15 20:04:56 +00:00
If you want to translate Misskey, please see [Translation guide](./docs/translate.en.md).
2018-04-14 22:14:00 +00:00
:heart: Backers & Sponsors
2017-05-18 05:56:23 +00:00
----------------------------------------------------------------
2018-04-14 15:02:16 +00:00
[![Backers][backers-image]][support-url]
2018-04-14 22:14:00 +00:00
[![Sponsors][sponsors-image]][support-url]
2017-08-28 12:25:47 +00:00
2018-04-15 12:06:23 +00:00
<a href="https://www.patreon.com/syuilo"><img src="http://i.imgur.com/xEO164Z.png" alt="Become a Patron!" width="200" /></a>
2018-03-29 02:13:40 +00:00
:mortar_board: Notable contributors
----------------------------------------------------------------
2018-03-29 02:44:24 +00:00
| ![syuilo][syuilo-icon] | ![Morisawa Aya][ayamorisawa-icon] | ![otofune][otofune-icon] | ![akihikodaki][akihikodaki-icon] | ![rinsuki][rinsuki-icon] |
|:-:|:-:|:-:|:-:|:-:|
| [syuilo][syuilo-link]<br>Owner | [Aya Morisawa][ayamorisawa-link]<br>Collaborator | [otofune][otofune-link]<br>Collaborator | [akihikodaki][akihikodaki-link] | [rinsuki][rinsuki-link] |
[List of all contributors](https://github.com/syuilo/misskey/graphs/contributors)
2018-04-16 06:01:46 +00:00
### :earth_americas: Translators
2018-04-16 05:58:18 +00:00
| ![][mirro-san-icon] | ![][Conan-kun-icon] |
|:-:|:-:|
| [Mirro][mirro-san-link]<br>English, French | [Asriel][Conan-kun-link]<br>English, French |
2018-03-29 02:13:40 +00:00
:four_leaf_clover: Copyright
2017-05-18 05:56:23 +00:00
----------------------------------------------------------------
2018-03-28 14:01:42 +00:00
> Copyright (c) 2014-2018 syuilo
2018-03-28 13:56:28 +00:00
Misskey is an open-source software licensed under [GNU AGPLv3](LICENSE).
2018-03-25 11:19:32 +00:00
2018-04-01 10:43:27 +00:00
[![][agpl-3.0-badge]][AGPL-3.0]
2018-03-25 11:19:32 +00: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 22:49:51 +00:00
[travis-link]: https://travis-ci.org/syuilo/misskey
2017-02-26 16:46:43 +00:00
[travis-badge]: http://img.shields.io/travis/syuilo/misskey/master.svg?style=flat-square
2017-11-23 02:47:19 +00:00
[dependencies-link]: https://david-dm.org/syuilo/misskey
[dependencies-badge]: https://img.shields.io/david/syuilo/misskey.svg?style=flat-square
2017-01-24 09:41:07 +00:00
[himasaku]: https://himasaku.net
[himawari-badge]: https://img.shields.io/badge/%E5%8F%A4%E8%B0%B7-%E5%90%91%E6%97%A5%E8%91%B5-1684c5.svg?style=flat-square
[sakurako-badge]: https://img.shields.io/badge/%E5%A4%A7%E5%AE%A4-%E6%AB%BB%E5%AD%90-efb02a.svg?style=flat-square
2017-03-01 08:02:07 +00:00
2018-04-14 15:02:16 +00:00
[backer-url]: #backers
2018-04-14 22:14:00 +00:00
[backer-badge]: https://opencollective.com/misskey/backers/badge.svg
2018-04-14 15:02:16 +00:00
[backers-image]: https://opencollective.com/misskey/backers.svg
2018-04-14 22:14:00 +00:00
[sponsor-url]: #sponsors
[sponsor-badge]: https://opencollective.com/misskey/sponsors/badge.svg
[sponsors-image]: https://opencollective.com/misskey/sponsors.svg
2018-04-14 15:02:16 +00:00
[support-url]: https://opencollective.com/misskey#support
2018-03-28 13:30:52 +00:00
<!-- Contributors Info -->
2017-03-01 08:02:07 +00:00
[syuilo-link]: https://syuilo.com
[syuilo-icon]: https://avatars2.githubusercontent.com/u/4439005?v=3&s=70
[ayamorisawa-link]: https://github.com/ayamorisawa
[ayamorisawa-icon]: https://avatars0.githubusercontent.com/u/10798641?v=3&s=70
[otofune-link]: https://github.com/otofune
[otofune-icon]: https://avatars0.githubusercontent.com/u/15062473?v=3&s=70
2018-03-28 13:30:52 +00:00
[akihikodaki-link]: https://github.com/akihikodaki
[akihikodaki-icon]: https://avatars2.githubusercontent.com/u/17036990?s=70&v=4
2018-03-29 02:44:24 +00:00
[rinsuki-link]: https://github.com/rinsuki
[rinsuki-icon]: https://avatars0.githubusercontent.com/u/6533808?s=70&v=4
2018-04-16 05:58:18 +00:00
[mirro-san-link]: https://github.com/mirro-san
[mirro-san-icon]: https://avatars1.githubusercontent.com/u/17948612?s=70&v=4
[Conan-kun-link]: https://github.com/Conan-kun
[Conan-kun-icon]: https://avatars3.githubusercontent.com/u/30003708?s=70&v=4