Skip to content

Commit 009e3c5

Browse files
committed
Preparation for new release
1 parent b4558a4 commit 009e3c5

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

README.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
[![Latest Stable Version](https://poser.pugx.org/peehaa/mailgrab/v/stable)](https://packagist.org/packages/peehaa/mailgrab)
44
[![Build Status](https://travis-ci.org/PeeHaa/mailgrab.svg?branch=master)](https://travis-ci.org/PeeHaa/mailgrab)
5-
[![Coverage Status](https://coveralls.io/repos/github/PeeHaa/mailgrab/badge.svg?branch=master)](https://coveralls.io/github/PeeHaa/mailgrab?branch=master)
65
[![Build status](https://ci.appveyor.com/api/projects/status/0vg23vb7ohyuxjqr/branch/master?svg=true)](https://ci.appveyor.com/project/PeeHaa/mailgrab/branch/master)
6+
[![Coverage Status](https://coveralls.io/repos/github/PeeHaa/mailgrab/badge.svg?branch=master)](https://coveralls.io/github/PeeHaa/mailgrab?branch=master)
77
[![License](https://poser.pugx.org/peehaa/mailgrab/license)](https://packagist.org/packages/peehaa/mailgrab)
88

99
Catch-all SMTP server for local debugging purposes.
@@ -19,12 +19,11 @@ This SMTP server catches all e-mail being sent through it and provides an interf
1919
This project is currently working towards a first stable release version.
2020
The master branch of this project will always be in a functioning state and will always point to the last release.
2121

22-
All active development should be based off the v0.3.0 branch.
22+
All active development should be based off the v0.4.0 branch.
2323

2424
### Current limitations
2525

26-
- Currently the project only supports unauthenticated smtp requests (without `AUTH` command).
27-
- Attachments are not supported as downloads
26+
- Currently the project only supports unauthenticated smtp requests (without `AUTH` command)
2827
- No persistent storage
2928
- Because we currently only support in-memory storage the project may run out of memory when handling a lot of mails or mails with a lot attachments
3029

@@ -40,7 +39,7 @@ All active development should be based off the v0.3.0 branch.
4039

4140
### Phar
4241

43-
Download the latest phar file from the [releases](https://github.com/PeeHaa/mailgrab/releases) page and make the file executable.
42+
Download the latest phar file from the [releases](https://github.com/PeeHaa/mailgrab/releases) page.
4443

4544
## Usage
4645

@@ -53,6 +52,10 @@ Download the latest phar file from the [releases](https://github.com/PeeHaa/mail
5352

5453
*See `./bin/mailgrab --help` for more configuration options*
5554

55+
Once the MailGrab server is started you can point your browser to `http://localhost:9000` to access the webinterface.
56+
If you send a mail to the server over port 9025 it will automatically be displayed in the webinterface.
57+
There are example mail scripts available under `./examples` (e.g. `php examples/full-test.php`) which you can run to test the functionality.
58+
5659
### Phar
5760

5861
`/path/to/mailgrab.phar` will start MailGrab using the default configuration:
@@ -62,10 +65,6 @@ Download the latest phar file from the [releases](https://github.com/PeeHaa/mail
6265

6366
*See `/path/to/mailgrab.phar --help` for more configuration options*
6467

65-
Once the MailGrab server is started you can point your browser to `http://localhost:9000` to access the webinterface.
66-
If you send a mail to the server over port 9025 it will automatically be displayed in the webinterface.
67-
There are example mail scripts available under `./examples` (e.g. `php examples/full-test.php`) which you can run to test the functionality.
68-
6968
## Build and development
7069

7170
### NPM
@@ -76,6 +75,6 @@ An NPM build script is provided and can be used by running `npm run build` in th
7675

7776
### Building phars
7877

79-
Currently all active development has to be based off the v0.3.0 branch.
78+
Currently all active development has to be based off the v0.4.0 branch.
8079

8180
If you want to build a phar you can run the build script located at `./bin/build` which will create a new build in the `./build` directory.

public/js/bundle.js.map

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)