Skip to content

Commit 96ff595

Browse files
committed
Merge pull request #10 from buffcode/master
Cleaned code, updated TravisCI configuration, directory renaming, updated README
2 parents d8a9d8e + a5cc959 commit 96ff595

32 files changed

+1211
-1257
lines changed

.travis.yml

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
sudo: false
12
language: php
23
php:
34
- 5.3
@@ -7,8 +8,12 @@ php:
78
- hhvm
89

910
before_script:
10-
- cd Tests
11-
- wget http://getcomposer.org/composer.phar
12-
- php composer.phar install
11+
- cd tests
12+
- composer install -n
1313

14-
script: ./phpunit --coverage-text --configuration phpunit.xml.dist
14+
script: phpunit --coverage-text --configuration phpunit.xml.dist
15+
16+
cache:
17+
directories:
18+
- tests/vendor
19+
- $HOME/.composer/cache

README.md

Lines changed: 16 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -61,9 +61,14 @@ Output:
6161

6262
## Installation
6363

64-
You can install via Composer.
64+
### Easy installation
65+
You can install directly via [Composer](https://getcomposer.org/):
66+
```bash
67+
$ composer require suin/php-rss-writer
68+
```
6569

66-
At first create `composer.json` file:
70+
### Manual installation
71+
Add the following code to your `composer.json` file:
6772

6873
```json
6974
{
@@ -73,24 +78,23 @@ At first create `composer.json` file:
7378
}
7479
```
7580

76-
Run composer to install.
77-
78-
```
81+
...and run composer to install it:
82+
```bash
7983
$ composer install
8084
```
8185

82-
Finally, include `vendor/autoload.php` in your product.
83-
84-
```
86+
Finally, include `vendor/autoload.php` in your product:
87+
```php
88+
<?php
8589
require_once 'vendor/autoload.php';
8690
```
8791

88-
## How to Use
92+
## How to use
8993

90-
`example.php` is an example usage of RSSWriter.
94+
The [`examples`](examples) directory contains usage examples for RSSWriter.
9195

92-
If you want to know APIs, please see `FeedInterface`, `ChannelInterface` and `ItemInterface`.
96+
If you want to know APIs, please see [`FeedInterface`](src/Suin/RSSWriter/FeedInterface.php), [`ChannelInterface`](src/Suin/RSSWriter/ChannelInterface.php) and [`ItemInterface`](src/Suin/RSSWriter/ItemInterface.php).
9397

9498
## License
9599

96-
MIT license
100+
MIT license

Source/Suin/RSSWriter/Channel.php

Lines changed: 0 additions & 189 deletions
This file was deleted.

Source/Suin/RSSWriter/ChannelInterface.php

Lines changed: 0 additions & 91 deletions
This file was deleted.

0 commit comments

Comments
 (0)