Skip to content

Commit b916671

Browse files
committed
chore(doc): [README] update readme
1 parent f87010b commit b916671

File tree

1 file changed

+8
-45
lines changed

1 file changed

+8
-45
lines changed

README.md

Lines changed: 8 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -24,61 +24,24 @@ Custom fields can be utilized to extend a model and offer a more flexible approa
2424

2525
## Installation
2626

27-
```bash
27+
Install the package via composer
28+
29+
```
2830
composer require onramplab/laravel-custom-fields
2931
```
32+
Publish migration files and run command to build tables needed in the package
3033

31-
This will create a basic project structure for you:
32-
33-
* **/build** is used to store code coverage output by default;
34-
* **/src** is where your codes will live in, each class will need to reside in its own file inside this folder;
35-
* **/tests** each class that you write in src folder needs to be tested before it was even "included" into somewhere else. So basically we have tests classes there to test other classes;
36-
* **.gitignore** there are certain files that we don't want to publish in Git, so we just add them to this fle for them to "get ignored by git";
37-
* **CHANGELOG.md** to keep track of package updates;
38-
* **CONTRIBUTION.md** Contributor Covenant Code of Conduct;
39-
* **LICENSE** terms of how much freedom other programmers is allowed to use this library;
40-
* **README.md** it is a mini documentation of the library, this is usually the "home page" of your repo if you published it on GitHub and Packagist;
41-
* **composer.json** is where the information about your library is stored, like package name, author and dependencies;
42-
* **phpunit.xml** It is a configuration file of PHPUnit, so that tests classes will be able to test the classes you've written;
43-
* **.travis.yml** basic configuration for Travis CI with configured test coverage reporting for code climate.
34+
```
35+
php artisan vendor:publish --tag="custom-fields-migrations"
36+
```
4437

45-
Please refer to original [article](http://www.darwinbiler.com/creating-composer-package-library/) for more information.
38+
## Usage
4639

47-
## Useful Tools
4840

4941
## Running Tests:
5042

51-
php vendor/bin/phpunit
52-
53-
or
54-
5543
composer test
5644

57-
## Code Sniffer Tool:
58-
59-
php vendor/bin/phpcs --standard=PSR2 src/
60-
61-
or
62-
63-
composer psr2check
64-
65-
## Code Auto-fixer:
66-
67-
composer psr2autofix
68-
composer insights:fix
69-
rector:fix
70-
71-
## Building Docs:
72-
73-
php vendor/bin/phpdoc -d "src" -t "docs"
74-
75-
or
76-
77-
composer docs
78-
79-
## Changelog
80-
81-
To keep track, please refer to [CHANGELOG.md](https://github.com/Onramplab/laravel-custom-fields/blob/master/CHANGELOG.md).
8245

8346
## Contributing
8447

0 commit comments

Comments
 (0)