Skip to content

Commit 9cc77d1

Browse files
committed
Merge pull request #31 from tedivm/Marketing
Updated readme
2 parents acfc1c0 + cb15c2f commit 9cc77d1

File tree

1 file changed

+37
-16
lines changed

1 file changed

+37
-16
lines changed

README.md

Lines changed: 37 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,44 @@
1-
Fetch
2-
=====
1+
# Fetch [![Build Status](https://travis-ci.org/tedivm/Fetch.png?branch=master)](https://travis-ci.org/tedivm/Fetch)
2+
3+
[![Latest Stable Version](https://poser.pugx.org/tedivm/fetch/v/stable.png)](https://packagist.org/packages/tedivm/fetch)
4+
[![Total Downloads](https://poser.pugx.org/tedivm/fetch/downloads.png)](https://packagist.org/packages/tedivm/fetch)
35

46
Fetch is a library for reading email and attachments, primarily using the POP
57
and IMAP protocols.
68

7-
Fetch was part of a large project, Mortar, which is hosted on Google Code. It is
8-
currently being migrated over to Github, as well as being updated to support
9-
modern php features. While the project is in flux I encourage you to try it out,
10-
but be careful about using it in a production environment without proper
11-
testing.
129

13-
Installation
14-
============
10+
## Installing
11+
12+
### Composer
13+
14+
Installing Fetch can be done through a variety of methods, although Composer is
15+
recommended.
16+
17+
Until Fetch reaches a stable API with version 1.0 it is recommended that you
18+
review changes before even Minor updates, although bug fixes will always be
19+
backwards compatible.
20+
21+
```
22+
"require": {
23+
"tedivm/fetch": "0.5.*"
24+
}
25+
```
26+
27+
### Pear
1528

16-
The most easy way to install the library is via composer. To do so, you have to do
17-
the following:
29+
Fetch is also available through Pear.
1830

19-
php composer.phar require tedivm/fetch
31+
```
32+
$ pear channel-discover pear.tedivm.com
33+
$ pear install tedivm/Fetch
34+
```
2035

21-
Composer will then ask you which version you want to install. Until there are stable
22-
versions, by using "@dev" it'll install the latest version.
36+
### Github
2337

24-
Sample Usage
25-
============
38+
Releases of Stash are available on [Github](https://github.com/tedivm/Fetch/releases).
39+
40+
41+
## Sample Usage
2642

2743
This is just a simple code to show how to access messages by using Fetch. It uses Fetch
2844
own autoload, but it can (and should be, if applicable) replaced with the one generated
@@ -39,3 +55,8 @@ by composer.
3955
foreach ($messages as $message) {
4056
echo "Subject: {$message->getSubject()}\nBody: {$message->getMessageBody()}\n";
4157
}
58+
59+
60+
## License
61+
62+
Fetch is licensed under the BSD License. See the LICENSE file for details.

0 commit comments

Comments
 (0)