misskey/README.md

88 lines
4.4 KiB
Markdown
Raw Normal View History

# オスカー。
**This repository is not for "general" purpose, so use this code at your own risk.**
Following one is original Misskey.io repository's README.
---
2021-02-07 11:43:55 +09:00
<div align="center">
<a href="https://misskey-hub.net">
2024-03-02 18:34:49 +09:00
<img src="./assets/title_float.svg" alt="Misskey logo" style="border-radius:50%" width="300"/>
</a>
2024-03-02 18:34:49 +09:00
**🌎 **Misskey** is an open source, federated social media platform that's free forever! 🚀**
[Learn more](https://misskey-hub.net/)
2021-11-21 18:40:09 +09:00
---
2022-05-24 15:10:00 +09:00
<a href="https://misskey-hub.net/servers/">
2022-05-24 15:10:00 +09:00
<img src="https://custom-icon-badges.herokuapp.com/badge/find_an-instance-acea31?logoColor=acea31&style=for-the-badge&logo=misskey&labelColor=363B40" alt="find an instance"/></a>
<a href="https://misskey-hub.net/docs/for-admin/install/guides/">
2022-05-24 15:10:00 +09:00
<img src="https://custom-icon-badges.herokuapp.com/badge/create_an-instance-FBD53C?logoColor=FBD53C&style=for-the-badge&logo=server&labelColor=363B40" alt="create an instance"/></a>
<a href="./CONTRIBUTING.md">
2022-05-24 15:10:00 +09:00
<img src="https://custom-icon-badges.herokuapp.com/badge/become_a-contributor-A371F7?logoColor=A371F7&style=for-the-badge&logo=git-merge&labelColor=363B40" alt="become a contributor"/></a>
<a href="https://discord.gg/Wp8gVStHW3">
2022-05-24 15:10:00 +09:00
<img src="https://custom-icon-badges.herokuapp.com/badge/join_the-community-5865F2?logoColor=5865F2&style=for-the-badge&logo=discord&labelColor=363B40" alt="join the community"/></a>
<a href="https://www.patreon.com/syuilo">
2022-05-24 15:10:00 +09:00
<img src="https://custom-icon-badges.herokuapp.com/badge/become_a-patron-F96854?logoColor=F96854&style=for-the-badge&logo=patreon&labelColor=363B40" alt="become a patron"/></a>
2021-02-07 11:43:55 +09:00
</div>
2021-11-20 18:21:18 +09:00
<div>
2021-03-24 11:57:12 +09:00
<a href="https://xn--931a.moe/"><img src="https://github.com/MisskeyIO/misskey/blob/io/assets/ai.png?raw=true" align="right" height="320px"/></a>
2018-09-13 05:35:11 +09:00
2021-11-21 18:40:09 +09:00
## ✨ Features
- **ActivityPub support**\
Not on Misskey? No problem! Not only can Misskey instances talk to each other, but you can make friends with people on other networks like Mastodon and Pixelfed!
2021-11-21 18:40:09 +09:00
- **Reactions**\
You can add emoji reactions to any post! No longer are you bound by a like button, show everyone exactly how you feel with the tap of a button.
2021-11-21 18:40:09 +09:00
- **Drive**\
With Misskey's built in drive, you get cloud storage right in your social media, where you can upload any files, make folders, and find media from posts you've made!
2021-11-21 18:40:09 +09:00
- **Rich Web UI**\
Misskey has a rich and easy to use Web UI!
It is highly customizable, from changing the layout and adding widgets to making custom themes.
Furthermore, plugins can be created using AiScript, an original programming language.
- And much more...
2019-02-06 00:13:31 +09:00
2021-11-20 18:21:18 +09:00
</div>
2017-01-23 18:25:52 +09:00
2021-11-20 18:21:18 +09:00
<div style="clear: both;"></div>
2018-04-16 05:04:56 +09:00
## Documentation
Misskey Documentation can be found at [Misskey Hub](https://misskey-hub.net/docs/), some of the links and graphics above also lead to specific portions of it.
## Sponsors of Misskey
2023-04-06 06:12:29 +09:00
List of sponsors of Misskey can be found at [Misskey Hub](https://misskey-hub.net/).
## Sponsors of Misskey.io
<div style="display:flex;flex-direction:column;gap:8px 8px;align-items:center;justify-content:center;">
<a title="Skeb" href="https://skeb.jp/" target="_blank"><img src="https://media.misskeyusercontent.jp/misskey-io/sponsors/skeb.svg" alt="Skeb" width="140"></a>
2021-09-18 03:26:52 +09:00
</div>
2023-04-06 06:12:29 +09:00
## Thanks
2023-04-08 17:02:18 +09:00
<a href="https://www.chromatic.com/"><img src="https://user-images.githubusercontent.com/321738/84662277-e3db4f80-af1b-11ea-88f5-91d67a5e59f6.png" height="30" alt="Chromatic" /></a>
2023-04-06 06:12:29 +09:00
Thanks to [Chromatic](https://www.chromatic.com/) for providing the visual testing platform that helps us review UI changes and catch visual regressions.
2023-04-08 17:02:18 +09:00
<a href="https://about.codecov.io/for/open-source/"><img src="https://about.codecov.io/wp-content/themes/codecov/assets/brand/sentry-cobranding/logos/codecov-by-sentry-logo.svg" height="30" alt="Codecov" /></a>
Thanks to [Codecov](https://about.codecov.io/for/open-source/) for providing the code coverage platform that helps us improve our test coverage.
<a href="https://crowdin.com/"><img src="https://user-images.githubusercontent.com/20679825/230709597-1299a011-171a-4294-a91e-355a9b37c672.svg" height="30" alt="Crowdin" /></a>
Thanks to [Crowdin](https://crowdin.com/) for providing the localization platform that helps us translate Misskey into many languages.
<a href="https://hub.docker.com/"><img src="https://user-images.githubusercontent.com/20679825/230148221-f8e73a32-a49b-47c3-9029-9a15c3824f92.png" height="30" alt="Docker" /></a>
2023-04-06 06:12:29 +09:00
Thanks to [Docker](https://hub.docker.com/) for providing the container platform that helps us run Misskey in production.