Skip to content

Commit

Permalink
chore(Readme): customize readme
Browse files Browse the repository at this point in the history
Signed-off-by: Valentin Sickert <[email protected]>
  • Loading branch information
Lapotor committed Nov 1, 2023
1 parent 778d2f7 commit 4fedec2
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 50 deletions.
7 changes: 7 additions & 0 deletions .github/assets/RadioRoster.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
82 changes: 32 additions & 50 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,66 +1,48 @@
<p align="center"><a href="https://laravel.com" target="_blank"><img src="https://raw.githubusercontent.com/laravel/art/master/logo-lockup/5%20SVG/2%20CMYK/1%20Full%20Color/laravel-logolockup-cmyk-red.svg" width="400" alt="Laravel Logo"></a></p>
<p align="center"><img src=".github/assets/RadioRoster.svg" alt="RadioRoster" width="150px"/><h1>RadioRoster API</h1></p>

<p align="center">
<!--<p align="center">
<a href="https://github.com/laravel/framework/actions"><img src="https://github.com/laravel/framework/workflows/tests/badge.svg" alt="Build Status"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/dt/laravel/framework" alt="Total Downloads"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/v/laravel/framework" alt="Latest Stable Version"></a>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/laravel/framework" alt="License"></a>
</p>
<a href="https://packagist.org/packages/laravel/framework"><img src="https://img.shields.io/packagist/l/Lapotor/RadioRoster-api" alt="License"></a>
</p>-->

## About Laravel
## About RadioRoster

Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable and creative experience to be truly fulfilling. Laravel takes the pain out of development by easing common tasks used in many web projects, such as:
RadioRoster is a comprehensive web-based system designed to streamline the scheduling of radio shows and facilitate interaction with listeners through wishes and greetings. Our platform empowers radio stations and broadcasters to efficiently manage their programming while providing an engaging experience for their audience.

- [Simple, fast routing engine](https://laravel.com/docs/routing).
- [Powerful dependency injection container](https://laravel.com/docs/container).
- Multiple back-ends for [session](https://laravel.com/docs/session) and [cache](https://laravel.com/docs/cache) storage.
- Expressive, intuitive [database ORM](https://laravel.com/docs/eloquent).
- Database agnostic [schema migrations](https://laravel.com/docs/migrations).
- [Robust background job processing](https://laravel.com/docs/queues).
- [Real-time event broadcasting](https://laravel.com/docs/broadcasting).
### Prerequisites

Laravel is accessible, powerful, and provides tools required for large, robust applications.
- PHP 8.1 or higher
- Composer
- MariaDB, PostgreSQL, SQLite or another compatible database

## Learning Laravel
## Development

Laravel has the most extensive and thorough [documentation](https://laravel.com/docs) and video tutorial library of all modern web application frameworks, making it a breeze to get started with the framework.
We welcome contributions from the community! Whether you're a developer, designer, or enthusiast, your input can help make RadioRoster even better. Here are some guidelines to get you started:

You may also try the [Laravel Bootcamp](https://bootcamp.laravel.com), where you will be guided through building a modern Laravel application from scratch.
1. Fork the repository on GitHub.
2. Clone your forked repository to your local machine:
```bash
git clone https://github.com/yourusername/radioroster-api.git
```
3. Create a new branch for your contribution:
```bash
git checkout -b feature/new-feature
```
4. Make your changes and commit them with descriptive commit messages.
5. Push your changes to your forked repository:
```bash
git push origin feature/new-feature
```
6. Open a pull request on GitHub, comparing your branch to the `main` branch of the original repository.

If you don't feel like reading, [Laracasts](https://laracasts.com) can help. Laracasts contains over 2000 video tutorials on a range of topics including Laravel, modern PHP, unit testing, and JavaScript. Boost your skills by digging into our comprehensive video library.
Before submitting a pull request, please ensure that your code is properly tested. Write tests for any new features or changes you introduce.

## Laravel Sponsors

We would like to extend our thanks to the following sponsors for funding Laravel development. If you are interested in becoming a sponsor, please visit the [Laravel Partners program](https://partners.laravel.com).

### Premium Partners

- **[Vehikl](https://vehikl.com/)**
- **[Tighten Co.](https://tighten.co)**
- **[WebReinvent](https://webreinvent.com/)**
- **[Kirschbaum Development Group](https://kirschbaumdevelopment.com)**
- **[64 Robots](https://64robots.com)**
- **[Curotec](https://www.curotec.com/services/technologies/laravel/)**
- **[Cyber-Duck](https://cyber-duck.co.uk)**
- **[DevSquad](https://devsquad.com/hire-laravel-developers)**
- **[Jump24](https://jump24.co.uk)**
- **[Redberry](https://redberry.international/laravel/)**
- **[Active Logic](https://activelogic.com)**
- **[byte5](https://byte5.de)**
- **[OP.GG](https://op.gg)**

## Contributing

Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).

## Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the [Code of Conduct](https://laravel.com/docs/contributions#code-of-conduct).

## Security Vulnerabilities
## License

If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell via [[email protected]](mailto:[email protected]). All security vulnerabilities will be promptly addressed.
The RadioRoster API is licensed under the [AGPL-3.0 License](LICENSE).

## License
### Acknowledgments

The Laravel framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
- The Laravel community for providing an excellent framework.

0 comments on commit 4fedec2

Please sign in to comment.