Skip to content

Commit

Permalink
Initial release to GitHub.
Browse files Browse the repository at this point in the history
  • Loading branch information
schlessera committed Jan 29, 2016
0 parents commit df6ec74
Show file tree
Hide file tree
Showing 16 changed files with 2,229 additions and 0 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
vendor/
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Change Log
All notable changes to this project will be documented in this file.
This project adheres to [Semantic Versioning](http://semver.org/).

## [0.1.0] - 2016-01-13
### Added
- Initial release to GitHub.

[0.1.0]: https://github.com/brightnucleus/phpfeature/compare/v0.0.0...v0.1.0
21 changes: 21 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# Bright Nucleus Config Component

This is a very lean Config component to help you write reusable code. It only offers basic functionality and is meant to be used in libraries and small projects. If you need a Config component for more complex projects, you should take a look at the [Symfony Config Component](http://symfony.com/doc/current/components/config/index.html).

## Installation

The best way to use this component is through Composer:

```BASH
composer require brightnucleus/config
```

## Usage

A class that wants to be configurable should accept a `ConfigInterface` in its constructor, so that the Config can be injected. The surrounding code then should inject an instance of an object (for example the generic `Config` that is provided with this component). This way, the class that accepts the Config can be written in a 100% reusable way, while all project-specific stuff will be injected through the Config.

See [link to post coming soon] for more details.

## Contributing

All feedback / bug report / pull request is welcome.
23 changes: 23 additions & 0 deletions composer.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
{
"name": "brightnucleus/config",
"description": "Minimal, reusable Config component.",
"version": "0.1.0",
"require-dev": {
"phpunit/phpunit": "~5.1"
},
"license": "GPL-2.0+",
"authors": [
{
"name": "Alain Schlesser",
"email": "[email protected]"
}
],
"require": {
"symfony/options-resolver": "~3.0"
},
"autoload": {
"psr-4": {
"BrightNucleus\\Config\\": "src/"
}
}
}
Loading

0 comments on commit df6ec74

Please sign in to comment.