Skip to content

Commit 1979a7d

Browse files
committed
update readme
1 parent 2a1fa2e commit 1979a7d

File tree

1 file changed

+30
-16
lines changed

1 file changed

+30
-16
lines changed

readme.md

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,41 @@
1-
# Laravel PHP Framework
1+
# Timongo RPG
2+
[![Official package](https://img.shields.io/badge/official-package-blue.svg)](https://timongo.com)
23

3-
[![Build Status](https://travis-ci.org/laravel/framework.svg)](https://travis-ci.org/laravel/framework)
4-
[![Total Downloads](https://poser.pugx.org/laravel/framework/d/total.svg)](https://packagist.org/packages/laravel/framework)
5-
[![Latest Stable Version](https://poser.pugx.org/laravel/framework/v/stable.svg)](https://packagist.org/packages/laravel/framework)
6-
[![Latest Unstable Version](https://poser.pugx.org/laravel/framework/v/unstable.svg)](https://packagist.org/packages/laravel/framework)
7-
[![License](https://poser.pugx.org/laravel/framework/license.svg)](https://packagist.org/packages/laravel/framework)
4+
Timongo RPG is a totally open sourced learning project. The main goal is to put RPG and coding together in order to learn faster enjoying and easing the process.
85

9-
Laravel is a web application framework with expressive, elegant syntax. We believe development must be an enjoyable, creative experience to be truly fulfilling. Laravel attempts to take the pain out of development by easing common tasks used in the majority of web projects, such as authentication, routing, sessions, queueing, and caching.
6+
![RPG](https://upload.wikimedia.org/wikipedia/commons/2/2d/Dados_4_a_20_caras_trans.png)
107

11-
Laravel is accessible, yet powerful, providing tools needed for large, robust applications. A superb inversion of control container, expressive migration system, and tightly integrated unit testing support give you the tools you need to build any application with which you are tasked.
8+
## Installation
129

13-
## Official Documentation
10+
Clone the repository.
1411

15-
Documentation for the framework can be found on the [Laravel website](http://laravel.com/docs).
12+
```bash
13+
git clone [email protected]:timongorpg/timongo.git
14+
```
1615

17-
## Contributing
16+
Install composer dependencies.
17+
```bash
18+
composer install
19+
```
20+
21+
Install npm packages and publish assets.
22+
```bash
23+
npm install
24+
gulp
25+
```
1826

19-
Thank you for considering contributing to the Laravel framework! The contribution guide can be found in the [Laravel documentation](http://laravel.com/docs/contributions).
27+
## Production/Development Server
2028

21-
## Security Vulnerabilities
29+
- Ubuntu 16.04 LTS
30+
- PHP 7.0.8
31+
- Laravel PHP Framework 5.4.15
32+
- VueJS is used to some components (we are actually thinking in creating a entire SPA on top of vuejs, check this out)
33+
- MySQL Database
34+
35+
## Contributing
2236

23-
If you discover a security vulnerability within Laravel, please send an e-mail to Taylor Otwell at [email protected]. All security vulnerabilities will be promptly addressed.
37+
Pull requests should aim to `develop`. You're free to open issues to suggest changes. If you want to work on a hard feature i'd recommend you to join slack to be sure we are all on the same page.
2438

25-
## License
39+
## Slack
2640

27-
The Laravel framework is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT).
41+
I'm setting up a slack auto inviter for this project. Meanwhile, if you want to join us you should communicate it on timongo's global chat.

0 commit comments

Comments
 (0)