Skip to content

Template for the creation of component packages.

License

Notifications You must be signed in to change notification settings

Proximify/component-template

Repository files navigation

:package_name

Latest Version on Packagist Build Status Coverage Status Quality Score Total Downloads

Note: Replace :author_name :author_username :author_website :author_email :vendor :package_name :package_description with their correct values in README.md, CHANGELOG.md, CONTRIBUTING.md, LICENSE.md and composer.json files, then delete this line. You can run $ php prefill.php in the command line to make all replacements at once. Delete the file prefill.php as well.

This is where your description should go. Try and limit it to a paragraph or two.

Structure

If any of the following are applicable to your project, then the directory structure should follow industry best practices by being named the following.

bin/        
build/
docs/
config/
src/
tests/
vendor/

Install

Via Composer

$ composer require :vendor/:package_name

Usage

$skeleton = new Proximify\Skeleton();
echo $skeleton->echoPhrase('Hello, Proximify!');

Change log

Please see CHANGELOG for more information on what has changed recently.

Testing

$ composer test

Note: use PHAR to require testing packages instead of adding them to require-dev. By doing that, you will avoid polluting the vendor folder with lots of unnecessary packages.

Contributing

Please see CONTRIBUTING and CODE_OF_CONDUCT for details.

Security

If you discover any security related issues, please email :author_email instead of using the issue tracker.

License

Copyright (c) Proximify Inc. All rights reserved.

:package_name is made by Proximify. We invite the community to participate.

About

Template for the creation of component packages.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages