Skip to content

Commit

Permalink
Documenting
Browse files Browse the repository at this point in the history
  • Loading branch information
Sella-GH committed Nov 12, 2024
1 parent 446b5db commit 39dad62
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 24 deletions.
3 changes: 2 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,10 @@
### General
- Updated to .NET 9 including all dependencies
- Dockerfile improvements to improve image size

### Dependencies
- Added [NReco.Logging.File](https://github.com/nreco/logging) in version 1.2.1
- Updated [DSharpPlus](https://github.com/DSharpPlus/DSharpPlus) to version 5.0.0-nightly-02394
- Updated [DSharpPlus](https://github.com/DSharpPlus/DSharpPlus) to version 5.0.0-nightly-02407
- Updated [Lavalink4NET](https://github.com/angelobreuer/Lavalink4NET) to version 4.0.26-preview.4

### Additions
Expand Down
46 changes: 23 additions & 23 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,27 +33,27 @@
### Features
#### AzuraCast-specific
* Create, manage and work with your AzuraCast station directly from discord
* Check if new files were added to your station
* Check if new files have been added to your station
* Check if the instance needs some updates
* Check if your instance is still online or down
* Export your playlists
* Get the played song history
* Get some technical hardware stats of your server
* Get the history of songs played
* Get some technical hardware stats about your server
* Get the songs from inside your playlists
* Listen to your station's mount points inside voice channels
* Listen to your station's mount points within voice channels
* Remove songs from your song request queue
* Search and request a specific song on your station
* See what's currently played
* Find and request a specific song on your station
* See what's currently playing
* Skip songs if you don't want to hear them
* Start and stop your station
* Switch the current playlist
* Update your whole instance with a single command
* Users are able to upload files to a specific channel
* Change the current playlist
* Update your AzuraCast instance with a single command
* Allow users to upload files to a specific channel
* View your AzuraCast system logs

#### MusicStreaming specific
* Listen to songs from SoundCloud (only provider right now)
* Clear your upoming song queue (or one song of it)
* Listen to songs from SoundCloud (currently the only provider right now)
* Clear your upcoming song queue (or only one song from it)
* Get the played song history
* Get the upcoming play queue
* Pause the music
Expand All @@ -74,7 +74,7 @@ Follow the instructions inside the [wiki](https://github.com/Sella-GH/AzzyBot/wi
* [PostgreSQL](https://www.postgresql.org/)
* [Visual Studio 2022 Community](https://visualstudio.microsoft.com/de/downloads)

### Dependancies
### Dependencies
* [CsvHelper](https://github.com/JoshClose/CsvHelper)
* [DSharpPlus](https://github.com/DSharpPlus/DSharpPlus)
* [EntityFrameworkCore.Exceptions.PostgreSQL](https://github.com/Giorgi/EntityFramework.Exceptions)
Expand All @@ -91,19 +91,19 @@ Follow the instructions inside the [wiki](https://github.com/Sella-GH/AzzyBot/wi

## Contributing

Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/Sella-GH/AzzyBot/issues/new/choose) to discuss it, or directly create a pull request after you edit the *README.md* file with necessary changes.
* Please make sure you check your spelling and grammar.
* Create individual PR for each suggestion.
* Please also read through the [Code Of Conduct](https://github.com/Sella-GH/AzzyBot/blob/main/CODE_OF_CONDUCT.md) before posting your first idea as well.
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. All contributions you make are **greatly appreciated**.
* If you have suggestions for adding or removing projects, feel free to [open an issue](https://github.com/Sella-GH/AzzyBot/issues/new/choose) to discuss it, or create a pull request directly after editing the *README.md* file with necessary changes.
* Please be sure to check your spelling and grammar.
* Create a separate PR for each suggestion.
* Please also read through the [Code Of Conduct](https://github.com/Sella-GH/AzzyBot/blob/main/CODE_OF_CONDUCT.md) before submitting your first idea.

### Creating A Pull Request
### Create A Pull Request

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feat/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
4. Push to the Branch (`git push origin feat/AmazingFeature`)
5. Open a Pull Request
1. Fork the project
2. Create your feature franch (`git checkout -b feat/AmazingFeature`)
3. Commit your fhanges (`git commit -m 'Add some AmazingFeature'`)
4. Push to the branch (`git push origin feat/AmazingFeature`)
5. Open a pull request

## License

Expand Down

0 comments on commit 39dad62

Please sign in to comment.