Updated the library structure so that it's consistent with all other …

…Polder Knowledge libraries.

.editorconfig

@@ -0,0 +1,15 @@
+; This file is for unifying the coding style for different editors and IDEs.
+; More information at http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+indent_size = 4
+indent_style = space
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1,10 @@
+# Path-based git attributes
+# https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
+
+# Ignore all test and documentation with "export-ignore".
+/.gitattributes     export-ignore
+/.gitignore         export-ignore
+/.travis.yml        export-ignore
+/phpunit.xml.dist   export-ignore
+/.scrutinizer.yml   export-ignore
+/tests              export-ignore

.gitignore

@@ -0,0 +1,3 @@
+build/
+composer.lock
+vendor/

.scrutinizer.yml

@@ -0,0 +1,23 @@
+filter:
+    excluded_paths: [tests/*]
+
+checks:
+    php:
+        remove_extra_empty_lines: true
+        remove_php_closing_tag: true
+        remove_trailing_whitespace: true
+        fix_use_statements:
+            remove_unused: true
+            preserve_multiple: false
+            preserve_blanklines: true
+            order_alphabetically: true
+        fix_php_opening_tag: true
+        fix_linefeed: true
+        fix_line_ending: true
+        fix_identation_4spaces: true
+        fix_doc_comments: true
+
+tools:
+    external_code_coverage:
+        timeout: 600
+        runs: 3

.styleci.yml

@@ -0,0 +1 @@
+preset: psr2

.travis.yml

@@ -0,0 +1,60 @@
+language: php
+
+php:
+  - 5.5
+  - 5.6
+  - 7.0
+  - 7.1
+  - hhvm
+
+# This triggers builds to run on the new TravisCI infrastructure.
+# See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
+sudo: false
+
+## Cache composer
+cache:
+  directories:
+    - $HOME/.composer/cache
+    - "$HOME/.local"
+    - mkdocs-theme
+
+env:
+  global:
+    - SITE_URL: https://{PACKAGE_VENDOR}.github.io/{PACKAGE_NAME}
+    - GH_USER_NAME: "{ORGANIZATION}"
+    - GH_USER_EMAIL: jaap@polderknowledge.nl
+    - GH_REF: github.com/{PACKAGE_VENDOR}/{PACKAGE_NAME}.git
+
+matrix:
+  allow_failures:
+    - php: 5.5
+  include:
+    - php: 5.6
+      env:
+        - DEPLOY_DOCS="$(if [[ $TRAVIS_BRANCH == 'master' && $TRAVIS_PULL_REQUEST == 'false' ]]; then echo -n 'true' ; else echo -n 'false' ; fi)"
+        - PATH="$HOME/.local/bin:$PATH"
+    - php: 5.6
+      env: 'COMPOSER_FLAGS="--prefer-stable --prefer-lowest"'
+
+before_script:
+  - travis_retry composer self-update
+  - travis_retry composer update ${COMPOSER_FLAGS} --no-interaction --prefer-dist
+
+script:
+  - vendor/bin/phpcs --standard=psr2 src/
+  - vendor/bin/phpunit
+  - if [[ $DEPLOY_DOCS == "true" && "$TRAVIS_TEST_RESULT" == "0" ]]; then wget -O theme-installer.sh "https://raw.githubusercontent.com/polderknowledge/mkdocs-theme/master/theme-installer.sh" ; chmod 755 theme-installer.sh ; ./theme-installer.sh ; fi
+
+after_script:
+  - |
+    if [[ "$TRAVIS_PHP_VERSION" == '5.6' ]]; then
+      wget https://scrutinizer-ci.com/ocular.phar
+      php ocular.phar code-coverage:upload --format=php-clover build/logs/clover.xml
+    fi
+
+after_success:
+  - if [[ $DEPLOY_DOCS == "true" ]]; then ./mkdocs-theme/deploy.sh ; fi
+
+notifications:
+  email: false
+  irc: "irc.freenode.org#polderknowledge"

CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All Notable changes to `php-peek-lock` will be documented in this file.
+
+Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles.
+
+## NEXT - YYYY-MM-DD
+
+### Added
+- Nothing
+
+### Deprecated
+- Nothing
+
+### Fixed
+- Nothing
+
+### Removed
+- Nothing
+
+### Security
+- Nothing

CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at `wij@polderknowledge.nl`. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,32 @@
+# Contributing
+
+Contributions are **welcome** and will be fully **credited**.
+
+We accept contributions via Pull Requests on [Github](https://github.com/polderknowledge/php-peek-lock).
+
+
+## Pull Requests
+
+- **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
+
+- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+
+- **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
+
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+
+- **Create feature branches** - Don't ask us to pull from your master branch.
+
+- **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
+
+- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
+
+
+## Running Tests
+
+``` bash
+$ composer test
+```
+
+
+**Happy coding**!

ISSUE_TEMPLATE.md

@@ -0,0 +1,27 @@
+<!-- Provide a general summary of the issue in the Title above -->
+
+## Detailed description
+
+Provide a detailed description of the change or addition you are proposing.
+
+Make it clear if the issue is a bug, an enhancement or just a question.
+
+## Context
+
+Why is this change important to you? How would you use it?
+
+How can it benefit other users?
+
+## Possible implementation
+
+Not obligatory, but suggest an idea for implementing addition or change.
+
+## Your environment
+
+Include as many relevant details about the environment you experienced the bug in and how to reproduce it.
+
+* Version used (e.g. PHP 5.6, HHVM 3):
+* Operating system and version (e.g. Ubuntu 16.04, Windows 7):
+* Link to your project:
+* ...
+* ...

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,45 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+
+Describe your changes in detail.
+
+## Motivation and context
+
+Why is this change required? What problem does it solve?
+
+If it fixes an open issue, please link to the issue here (if you write `fixes #num`
+or `closes #num`, the issue will be automatically closed when the pull is accepted.)
+
+## How has this been tested?
+
+Please describe in detail how you tested your changes.
+
+Include details of your testing environment, and the tests you ran to
+see how your change affects other areas of the code, etc.
+
+## Screenshots (if appropriate)
+
+## Types of changes
+
+What types of changes does your code introduce? Put an `x` in all the boxes that apply:
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist:
+
+Go over all the following points, and put an `x` in all the boxes that apply.
+
+Please, please, please, don't send your pull request until all of the boxes are ticked.
+
+- [ ] I have read the **[CONTRIBUTING](CONTRIBUTING.md)** document.
+- [ ] My pull request addresses exactly one patch/feature.
+- [ ] I have created a branch for this patch/feature.
+- [ ] Each individual commit in the pull request is meaningful.
+- [ ] I have added tests to cover my changes.
+- [ ] All new and existing tests passed.
+- [ ] If my change requires a change to the documentation, I have updated it accordingly.
+- [ ] My code follows the code style of this project.
+
+If you're unsure about any of these, don't hesitate to ask. We're here to help!

README.md

@@ -1,14 +1,73 @@
-
 # php-peek-lock
 
-A wrapper around flock()
+[![Latest Version on Packagist][ico-version]][link-packagist]
+[![Software License][ico-license]](LICENSE.md)
+[![Build Status][ico-travis]][link-travis]
+[![Coverage Status][ico-scrutinizer]][link-scrutinizer]
+[![Quality Score][ico-code-quality]][link-code-quality]
+[![Total Downloads][ico-downloads]][link-downloads]
+
+A PHP library which acts as a wrapper around flock()
 
 You can use this to run jobs in the background and peek from the webserver if they are still running.
 
-## Installation
+## Install
 
 Via Composer
 
 ``` bash
 $ composer require polderknowledge/php-peek-lock
 ```
+
+## Usage
+
+Please read the documentation for this package for a quick setup.
+
+## Change log
+
+Please see [CHANGELOG](CHANGELOG.md) for more information what has changed recently.
+
+## Testing
+
+``` bash
+$ composer test
+```
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) and [CONDUCT](CONDUCT.md) for details.
+
+## Security
+
+If you discover any security related issues, please report them via [HackerOne](https://hackerone.com/polderknowledge) 
+instead of using the issue tracker or e-mail.
+
+## Community
+
+We have an IRC channel where you can find us every now and then. We're on the Freenode network in the
+channel #polderknowledge.
+
+## Credits
+
+- [Polder Knowledge][link-author]
+- [All Contributors][link-contributors]
+
+## License
+
+Please see [LICENSE.md][link-license] for the license of this application.
+
+[ico-version]: https://img.shields.io/packagist/v/polderknowledge/php-peek-lock.svg?style=flat-square
+[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square
+[ico-travis]: https://img.shields.io/travis/polderknowledge/php-peek-lock/master.svg?style=flat-square
+[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/polderknowledge/php-peek-lock.svg?style=flat-square
+[ico-code-quality]: https://img.shields.io/scrutinizer/g/polderknowledge/php-peek-lock.svg?style=flat-square
+[ico-downloads]: https://img.shields.io/packagist/dt/polderknowledge/php-peek-lock.svg?style=flat-square
+
+[link-packagist]: https://packagist.org/packages/polderknowledge/php-peek-lock
+[link-travis]: https://travis-ci.org/polderknowledge/php-peek-lock
+[link-scrutinizer]: https://scrutinizer-ci.com/g/polderknowledge/php-peek-lock/code-structure
+[link-code-quality]: https://scrutinizer-ci.com/g/polderknowledge/php-peek-lock
+[link-downloads]: https://packagist.org/packages/polderknowledge/php-peek-lock
+[link-author]: https://polderknowledge.com
+[link-contributors]: ../../contributors
+[link-license]: LICENSE.md