update the readme file
This commit is contained in:
parent
0a9f007eac
commit
50e0977637
29
README.md
29
README.md
@ -1,24 +1,13 @@
|
|||||||
# Lumen PHP Framework
|
# SP Tarkov items API
|
||||||
|
|
||||||
[![Build Status](https://travis-ci.org/laravel/lumen-framework.svg)](https://travis-ci.org/laravel/lumen-framework)
|
## How to install
|
||||||
[![Total Downloads](https://img.shields.io/packagist/dt/laravel/framework)](https://packagist.org/packages/laravel/lumen-framework)
|
|
||||||
[![Latest Stable Version](https://img.shields.io/packagist/v/laravel/framework)](https://packagist.org/packages/laravel/lumen-framework)
|
|
||||||
[![License](https://img.shields.io/packagist/l/laravel/framework)](https://packagist.org/packages/laravel/lumen-framework)
|
|
||||||
|
|
||||||
Laravel Lumen is a stunningly fast PHP micro-framework for building web applications with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Lumen attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as routing, database abstraction, queueing, and caching.
|
* Close the repo
|
||||||
|
* Make sure you have PHP and compose installed on your PC
|
||||||
|
* To verify that you have PHP and composer working, try these commands `php -v` and `composer -v`
|
||||||
|
* Go inside the cloned repo and install the dependencies with this command `composer install`
|
||||||
|
* If you don't have a local server like Apache or Nginx, you can PHP to start a server with this command in the root folder of the repo `php -S localhost:8000 -t public`
|
||||||
|
|
||||||
## Official Documentation
|
## How to use
|
||||||
|
|
||||||
Documentation for the framework can be found on the [Lumen website](https://lumen.laravel.com/docs).
|
* Check the `routes/web.php` for the available routes and use whatever utility you are confortable with to call the API endpoints, ex: Postman
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Thank you for considering contributing to Lumen! The contribution guide can be found in the [Laravel documentation](https://laravel.com/docs/contributions).
|
|
||||||
|
|
||||||
## Security Vulnerabilities
|
|
||||||
|
|
||||||
If you discover a security vulnerability within Lumen, please send an e-mail to Taylor Otwell at taylor@laravel.com. All security vulnerabilities will be promptly addressed.
|
|
||||||
|
|
||||||
## License
|
|
||||||
|
|
||||||
The Lumen framework is open-sourced software licensed under the [MIT license](https://opensource.org/licenses/MIT).
|
|
Loading…
x
Reference in New Issue
Block a user