Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
sarthaksavvy committed Oct 9, 2018
1 parent 94e1a83 commit 65d5da2
Show file tree
Hide file tree
Showing 9 changed files with 330 additions and 235 deletions.
29 changes: 12 additions & 17 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1,18 +1,13 @@
/app export-ignore
/bootstrap export-ignore
/config export-ignore
/tests export-ignore
.gitattributes export-ignore
.gitignore export-ignore
.styleci.yml export-ignore
composer.lock export-ignore
box.json export-ignore
phpunit.xml.dist export-ignore
.travis.yml export-ignore
.scrutinizer.yml export-ignore
LICENSE.md export-ignore
README.md export-ignore
BACKERS.md export-ignore
CONTRIBUTING.md export-ignore
CHANGELOG.md export-ignore

/app export-ignore
/bootstrap export-ignore
/config export-ignore
/tests export-ignore
/resources export-ignore
/.gitattributes export-ignore
/.gitignore export-ignore
/.styleci.yml export-ignore
/composer.lock export-ignore
/phpunit.xml.dist export-ignore
/LICENSE.md export-ignore
/README.md export-ignore
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@
/.vagrant
.editorconfig
.DS_Store
/package
/package
46 changes: 44 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,48 @@ Laravel Packer was created by, and is maintained by [Sarthak Shrivastava](https:

- Built on with [Laravel-zero](http://laravel-zero.com).

---
## Installation

Full Documentation Coming soon ...
Install via composer.

```bash
composer global require bitfumes/laravel-packer dev-master --prefer-dist
```

## Creating new Package Scaffolding

```bash
packer new your-package-name {vendor} {author} {author_email}
```

With the above command it will create package scaffoldig for you.

Optional fields like 'vendor', 'author' and 'author_email' can also be given via command line interface if you are not willing to provide on command.

## Set default values

Another great feature is that you can set your default values for 'Vendor', 'author and 'author_email'

```bash
packer set:user author_name
```

```bash
packar set:vendor vendor_name
```

```bash
packar set:email author_name
```

## Same as Artisan commands

With this CLI, you will have access to all artisan commands you are familier on Laravel.

You can create controller just like you do with `php artisan`

```bash
packer make:controller controller_name
```

Explore all commands, just run `packer` on your command line.
Binary file modified builds/packer
Binary file not shown.
Binary file added builds/packer.phar
Binary file not shown.
17 changes: 4 additions & 13 deletions composer.json
Original file line number Diff line number Diff line change
Expand Up @@ -30,20 +30,11 @@
"Tests\\": "tests/"
}
},
"minimum-stability": "dev",
"config": {
"preferred-install": "dist",
"sort-packages": true,
"optimize-autoloader": true,
"platform": {
"ext-posix": "0"
"preferred-install": {
"*": "dist"
}
},
"scripts": {
"post-create-project-cmd": [
"@php application app:rename"
]
},
"minimum-stability": "dev",
"prefer-stable": true,
"bin": ["packer"]
"bin": ["builds/packer"]
}
Loading

0 comments on commit 65d5da2

Please sign in to comment.