Skip to content

Commit

Permalink
docs(readme): update and fix grammar (#2662)
Browse files Browse the repository at this point in the history
  • Loading branch information
kyranet authored Aug 18, 2024
1 parent 68d6dd5 commit 9ed7cf7
Showing 1 changed file with 25 additions and 22 deletions.
47 changes: 25 additions & 22 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,36 +26,43 @@

## Translating Skyra <a href="https://translation.skyra.pw" target="_blank"><img src="https://support.crowdin.com/assets/logos/crowdin-core-logo.png" align="right" width="30%"></a>

We use **Crowdin** to translate Skyra's messages into different languages. If you'd like to help by contributing new translations (or improving existing ones), [**click here.**](https://translation.skyra.pw) Thanks for any contributions!
We use **Crowdin** to translate Skyra's messages into different languages. If you'd like to help by contributing new
translations (or improving existing ones), [**click here**](https://translation.skyra.pw). Thank you in advance for any
contributions!

## A note to aspiring developers who want to self host Skyra
## A note to aspiring developers who want to self-host Skyra

The developer team does not support the idea of other self-hosted instances of Skyra. The team prides itself on providing the best experience and support for the end-users. As such, an offshoot or unaffiliated mirror of Skyra may cause ill effects on the reputation and image of Skyra. If you wish to see new features implemented, please refer to the developing guidelines linked above.
The development team does not support the idea of other self-hosted instances of Skyra. The team prides itself on
providing the best experience and support for the end-users. As such, an offshoot or unaffiliated mirror of Skyra may
cause ill effects on the reputation and image of Skyra. If you wish to see new features implemented, please refer to the
development guidelines linked above.

In addition, Skyra was built with a dependence on many services which need consistent maintenance and oversight in order to function and behave properly. These include, but are not limited to,
In addition, Skyra was built with a dependence on many services that need consistent maintenance and oversight to
function and behave properly. These include, but are not limited to,

- [`InfluxDB`] in order to keep anonymous metrics on bot usage
- [`InfluxDB`] to keep anonymous metrics on bot usage
- [`PostgreSQL`] as database
- Other external APIs, each requiring their own individual API keys.
- Other external APIs, each requiring their API keys.

With this in mind, it is also worth noting that Skyra will in no way be capable of running on services such as [Glitch] or [Heroku]. A dedicated VPS (Virtual Private Server) is required in order to maintain the proper production environment.
With this in mind, it is also worth noting that Skyra will in no way be capable of running on services such as [Glitch]
or [Heroku]. A dedicated VPS (Virtual Private Server) is required to maintain the proper production environment.

## Story

**A bit of story**: Skyra, formerly known as kyraBOT (renamed in the middle of March of 2017), is a multipurpose Discord
Bot that was born out of curiosity in a SoloLearn guild. With help from other developers, due to my lack of experience
(I made websites and templates for After Effects, but never a backend application). Skyra was born. Skyra's name comes
from a comment made by a user, joining "kyra" with "SkyNET", creating "SkyraNET", I liked the name and later, she got
renamed to "Skyra". Originally, it was going to be renamed as "Shiny" (name taken for the currency) or "Shyy" (original
name from the lore) however I decided "Skyra" would be a better name.
from a comment made by a user, who joined "Kyra" with "SkyNET", and created the name "SkyraNET", I liked the name and
later, she got renamed to "Skyra". Originally, it was going to be renamed as "Shiny" (name taken for the currency) or
"Shyy" (original name from the lore) however I decided "Skyra" would be a better name.

Skyra does not only feature almost every feature that is needed in the majority of guilds (discord servers) while being
completely configurable, she also has a backstory, inherited from the lore I have been creating since I was a child.
completely configurable, but also has a backstory, inherited from the lore I have been creating since I was a child.

There have been over 14 rewrites with an active development of over two years, I have met many developers and friends in
Discord, and in February 2017, I met the Dirigeants team, upon which I started to contribute to Komada, and later, for
Klasa. Later in September 2020 I split from Dirigeants along with many of these developers and friends and started [Sapphire][sapphiredev],
which is what Skyra is currently using, specifically [Sapphire Framework][]
Klasa. Later in September 2020 I split from Dirigeants along with many of these developers and friends and started
[Sapphire][sapphiredev], which is what Skyra is currently using, specifically [Sapphire Framework][]

_Who knows, I might write a [book] someday for Skyra's lore._

Expand All @@ -73,10 +80,11 @@ _Who knows, I might write a [book] someday for Skyra's lore._

## Buy us some doughnuts

Skyra Project is open source and always will be, even if we don't get donations. That said, we know there are amazing people who
may still want to donate just to show their appreciation. Thanks you very much in advance!
Skyra Project is open source and always will be, even if we don't get donations. That said, we know some amazing people
may still want to donate just to show their appreciation. Thank you very much in advance!

We accept donations through Patreon, BitCoin, Ethereum, and Litecoin. You can use the buttons below to donate through your method of choice.
We accept donations through Patreon, BitCoin, Ethereum, and Litecoin. You can use the buttons below to donate through
your method of choice.

| Donate With | QR | Address |
| :---------: | :----------------: | :----------------------------------------------------: |
Expand All @@ -90,20 +98,16 @@ We accept donations through Patreon, BitCoin, Ethereum, and Litecoin. You can us

Please make sure to read the [Contributing Guide][contributing] before making a pull request.

Thank you to all the people who already contributed to Skyra Project!
Thank you to all the people who already contributed to the Skyra Project!

<a href="https://github.com/skyra-project/skyra/graphs/contributors">
<img src="https://contrib.rocks/image?repo=skyra-project/skyra" />
</a>

[contributing]: https://github.com/skyra-project/.github/blob/main/.github/CONTRIBUTING.md
[`.net`]: https://docs.microsoft.com/en-gb/dotnet/
[`entity framework`]: https://docs.microsoft.com/en-gb/ef/
[`hasteserver`]: https://github.com/skyra-project/docker-images/tree/main/haste-server
[`influxdb`]: https://v2.docs.influxdata.com/v2.0/get-started/
[`node.js`]: https://nodejs.org/en/download/current/
[`postgresql`]: https://www.postgresql.org/download/
[`redis`]: https://redis.io
[bitcoin]: bitcoin:3JNzCHMTFtxYFWBnVtDM9Tt34zFbKvdwco?amount=0.01&label=Skyra%20Discord%20Bot
[bitcoinimage]: https://cdn.skyra.pw/gh-assets/bitcoin.png
[digitalocean]: https://www.digitalocean.com/
Expand All @@ -113,7 +117,6 @@ Thank you to all the people who already contributed to Skyra Project!
[heroku]: https://www.heroku.com/
[litecoin]: litecoin:MNVT1keYGMfGp7vWmcYjCS8ntU8LNvjnqM?amount=0.01&label=Skyra%20Discord%20Bot
[litecoinimage]: https://cdn.skyra.pw/gh-assets/litecoin.png
[netcup]: https://www.netcup.eu/
[patreon]: https://donate.skyra.pw/patreon
[patreonimage]: https://cdn.skyra.pw/gh-assets/patreon.png
[paypal]: https://donate.skyra.pw/paypal
Expand Down

0 comments on commit 9ed7cf7

Please sign in to comment.