Skip to content

Commit 29ae37c

Browse files
Merge pull request #15 from unicodeveloper/docs
Update Install Instructions
2 parents b5eb4b0 + b76fe92 commit 29ae37c

File tree

2 files changed

+23
-3
lines changed

2 files changed

+23
-3
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ after_script:
1818
- php ocular.phar code-coverage:upload --format=php-clover coverage.clover
1919

2020
notifications:
21-
slack: red-creek:5lI8ybvl6YTcCNPosh4TE13h
21+
slack: red-creek:5lI8ybvl6YTcCNPosh4TE13h

readme.md

Lines changed: 22 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@ here is another great tutorial for building a project management app for beginne
8080
Getting Started
8181
---------------
8282

83-
The easiest way to get started is to clone the repository:
83+
#### Via Cloning The Repository:
8484

8585
```bash
8686
# Get the project
@@ -99,7 +99,27 @@ php artisan migrate
9999

100100
php artisan serve
101101
```
102-
# This starter pack includes the following APIs. You will need to obtain appropriate credentials like Client ID, zClient secret, API key, or Username & Password by going through each provider and generate new credentials.
102+
103+
#### Via The Installer:
104+
105+
First, download the Laravel Hackathon Starter Pack Installer using Composer:
106+
107+
composer global require "unicodeveloper/hackathon-installer"
108+
109+
Make sure to place the `~/.composer/vendor/bin` directory (or the equivalent directory for your OS) in your PATH so the `larathon` executable can be located by your system.
110+
111+
Once installed, the `larathon new` command will create a fresh Laravel Hackathon Starter Pack installation in the directory you specify. For instance, `larathon new mvp` will create a directory named `mvp` containing a fresh Laravel Hackathon Starter Pack installation with all of it's dependencies already installed. This method of installation is much faster than installing via Composer:
112+
113+
larathon new mvp
114+
115+
#### Via Composer Create-Project
116+
117+
Alternatively, you may also install Laravel Hackathon Starter Pack by issuing the Composer `create-project` command in your terminal:
118+
119+
composer create-project --prefer-dist unicodeveloper/laravel-hackathon-starter hotel
120+
121+
This starter pack includes the following APIs. You will need to obtain appropriate credentials like Client ID, zClient secret, API key, or Username & Password by going through each provider and generate new credentials.
122+
103123
* Cloudder
104124
* Twitter
105125
* Twillo

0 commit comments

Comments
 (0)