Skip to content

Commit e0fe260

Browse files
committed
KRF-416 #resolve Added README file to each module
1 parent 1ffdac1 commit e0fe260

File tree

1 file changed

+67
-0
lines changed

1 file changed

+67
-0
lines changed

README.md

Lines changed: 67 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
1+
# Kraken Framework - Throwable Component
2+
3+
[![Build Status](https://travis-ci.org/kraken-php/framework.svg)](https://travis-ci.org/kraken-php/framework)
4+
[![Total Downloads](https://poser.pugx.org/kraken-php/throwable/downloads)](https://packagist.org/packages/kraken-php/throwable)
5+
[![Latest Stable Version](https://poser.pugx.org/kraken-php/throwable/v/stable)](https://packagist.org/packages/kraken-php/throwable)
6+
[![Latest Unstable Version](https://poser.pugx.org/kraken-php/throwable/v/unstable)](https://packagist.org/packages/kraken-php/throwable)
7+
[![License](https://poser.pugx.org/kraken-php/framework/license)](https://packagist.org/packages/kraken-php/framework)
8+
9+
> **Note:** This repository is part of [Kraken Framework][3]. It can be used as standalone library, but for the best
10+
efficiency we suggest you to also check out the rest of [Kraken Repository][5].
11+
12+
<br>
13+
<p align="center">
14+
<img src="https://avatars2.githubusercontent.com/u/15938282?v=3&s=150" />
15+
</p>
16+
17+
## Description
18+
19+
Kraken/Throwable is component that provides throwable hierarchy used in Kraken Framework and additional helpers.
20+
21+
See more in [official documentation][2].
22+
23+
## Feature Highlights
24+
25+
Kraken/Throwable features:
26+
27+
* Custom hierarchy of Throwables created in mind of unifying error and exception handling in PHP5 and PHP7,
28+
* Custom format for stack trace,
29+
* Support for chaining Throwables,
30+
* Built-in ErrorHandler,
31+
* Built-in ExceptionHandler,
32+
* Implementation of throwable objects proxy,
33+
* Kraken Framework compatibility,
34+
* ...and more.
35+
36+
## Requirements
37+
38+
* PHP-5.5, PHP-5.6 or PHP-7.0+,
39+
* UNIX or ~~Windows~~ OS.
40+
41+
## Installation
42+
43+
```
44+
composer require kraken-php/throwable
45+
```
46+
47+
## Tests
48+
49+
Tests are provided in [Framework Repository][3].
50+
51+
## Documentation
52+
53+
Documentation for this module can be found in the [official documentation][2].
54+
55+
## Contributing
56+
57+
This library is read-only subtree split of Kraken Framework. To make contributions, please go to [Framework Repository][3].
58+
59+
## License
60+
61+
This library licensed under the same license as [Kraken Framework][3].
62+
63+
[1]: http://kraken-php.com
64+
[2]: http://kraken-php.com/docs/0.3/throwable
65+
[3]: https://github.com/kraken-php/framework
66+
[4]: https://github.com/kraken-php/kraken
67+
[5]: https://github.com/kraken-php

0 commit comments

Comments
 (0)