Skip to content
This repository was archived by the owner on Aug 12, 2018. It is now read-only.

inoryy/php-project-skeleton

Repository files navigation

project_name

project_name is a PHP library for ... that ... by ...

Usage

Simple example:

<?php

// This file is generated by Composer
require_once 'vendor/autoload.php';

// ....

Installation

The first step to use project_name is to download Composer:

$ curl -s http://getcomposer.org/installer | php

Now add project_name to your app with Composer:

$ php composer.phar require project_full_name:stable_version

And that's it! Composer will automatically handle the rest.

Alternatively, you can manually add the dependency to composer.json file...

{
    "require": {
        "project_full_name": "stable_version"
    }
}

... and then install our dependencies using:

$ php composer.phar install

Requirements

  • PHP >= 5.3.8
  • ...

Contributing

See CONTRIBUTING.md file.

Running the Tests

To run unit tests, you'll need a set of dev dependencies you can install using Composer:

php composer.phar install --dev

Once installed, just launch the following command:

phpunit

Credits

....

License

project_name is released under the MIT License. See the bundled LICENSE file for details.

About

Skeleton for an open source library in PHP. Will post a blog with more details soon.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published