opdavies/gmail-filter-builder
1
0
Fork 0
mirror of https://github.com/opdavies/gmail-filter-builder.git synced 2025-03-13 05:26:57 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add usage instructions

Browse source 
Fixes #2
This commit is contained in:
Oliver Davies 2016-07-15 01:37:30 +01:00
parent c97775c5ad
commit 5c74cb51d1
1 changed files with 26 additions and 2 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

28
README.md
View file

@ -6,9 +6,33 @@ Inspired by the [gmail-britta](https://github.com/antifuchs/gmail-britta) Ruby l
## Usage
TODO
* Run `composer require opdavies/gmail-filter-builder` to download the library.
* Create a new PHP file and require `autoload.php`.
* Create an array of `GmailFilter` objects, each with it’s required methods.
* Pass the filters into an instance of `GmailFilterBuilder`.
```php
require __DIR__ . '/vendor/autoload.php';
$filters = [];
// Add filters.
$filters[] = GmailFilter::create();
...
// Display the output.
print GmailFilterBuilder($filters);
```
To generate the output, run PHP on the file - e.g. `php generate.php`.
By default, the output is displayed on screen. To generate a file, use the greater than symbol followed by a file name - e.g. `php generate.php > filters.xml`.
## Example
For a working example, see the [opdavies/gmail-filters](https://github.com/opdavies/gmail-filters/blob/master/generate.php) repository.
## License
MIT