Skip to content

Commit

Permalink
Add: README
Browse files Browse the repository at this point in the history
  • Loading branch information
K-Phoen committed Jul 2, 2013
1 parent 6880f73 commit 8f1c45d
Show file tree
Hide file tree
Showing 2 changed files with 66 additions and 0 deletions.
47 changes: 47 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
ITNLogViewerBundle
==================

Provides a quick way to access application logs.

Installation
------------

### Composer

Add `itn/log-viewer-bundle` to your required field. Then install/update your
dependencies.

### app/AppKernel.php

Register the `ITNLogViewerBundle`:

```php
# app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...
new ITN\Bundle\LogViewerBundle\ITNLogViewerBundle(),
);
}
```

### Routing

Add the following route in the `app/config/routing.yml` file.

```yaml
log_show:
pattern: /log/{env}
defaults: { _controller: ITNLogViewerBundle:Default:index }
```
**NB:** The logs will then be publicly accessible. It's up to you to restrict
the access to this route.
License
-------
This bundle is under the [MIT](https://github.com/cup-of-giraf/ITNLogViewerBundle/Resources/meta/LICENCE)
licence.
19 changes: 19 additions & 0 deletions Resources/meta/LICENCE
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
Copyright (c) 2013 Pierre Tachoire, Kévin Gomez

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

0 comments on commit 8f1c45d

Please sign in to comment.