Skip to content

Commit 24e3ab1

Browse files
committed
Added readme
1 parent f43b3cf commit 24e3ab1

File tree

3 files changed

+95
-0
lines changed

3 files changed

+95
-0
lines changed

README.md

Lines changed: 95 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,95 @@
1+
<!-- PROJECT LOGO -->
2+
<br />
3+
<p align="center">
4+
<a href="https://github.com/caffeinalab/trelire">
5+
<img src="res/post-stamp.png" alt="Logo" width="130" height="130">
6+
</a>
7+
<h1 align="center">TreLire</h1>
8+
9+
<p align="center">
10+
Your local post office will envy this one.
11+
</p>
12+
</p>
13+
14+
15+
16+
<!-- TABLE OF CONTENTS -->
17+
## Table of Contents
18+
19+
- [Table of Contents](#table-of-contents)
20+
- [About The Project](#about-the-project)
21+
- [How it works](#how-it-works)
22+
- [Getting Started](#getting-started)
23+
- [Updates](#updates)
24+
- [Usage](#usage)
25+
- [Contributing](#contributing)
26+
- [License](#license)
27+
- [Contact](#contact)
28+
29+
30+
31+
<!-- ABOUT THE PROJECT -->
32+
## About The Project
33+
![Product Name Screen Shot][screenshot]
34+
35+
36+
**TreLire** is a wp_mail tester plugin. Want to be sure WordPress is able to send what it needs, when it needs it? You're a plugin away from that.
37+
38+
### How it works
39+
TreLire adds a page to the WordPress' tools, and makes you able to send emails from there. You can personalize your email as you want, by adding
40+
* Content Type
41+
* Multiple recipients
42+
* Sender
43+
* Reply-to
44+
* CC
45+
* BCC
46+
* Subject
47+
* Attachments, using WP's media uploader.
48+
* HTML body
49+
50+
51+
52+
<!-- GETTING STARTED -->
53+
## Getting Started
54+
55+
You can just clone this repository inside your `wp-content/plugins` folder, or [download the installable zip](https://github.com/caffeinalab/trelire/zipball/master) and install it via the WordPress dashboard.
56+
57+
### Updates
58+
Right now, you have to manually update the plugin by checking this GitHub repo.
59+
60+
61+
<!-- USAGE EXAMPLES -->
62+
## Usage
63+
64+
To use TreLire, just install it to your WordPress website and click on the Tools menu. You can now send emails and test your WordPress website.
65+
Need to use SMTP instead of your provider's mail? Check [Postino](https://github.com/caffeinalab/postino)!
66+
67+
68+
<!-- CONTRIBUTING -->
69+
## Contributing
70+
71+
Contributions are what make the open source community such an amazing place to be learn, inspire, and create. Any contributions you make are **greatly appreciated**.
72+
73+
1. Fork the Project
74+
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
75+
3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)
76+
4. Push to the Branch (`git push origin feature/AmazingFeature`)
77+
5. Open a Pull Request
78+
79+
80+
81+
<!-- LICENSE -->
82+
## License
83+
84+
Distributed under the GPL License. See `LICENSE` for more information.
85+
<div>Icon made by <a href="https://www.flaticon.com/authors/freepik" title="Freepik">Freepik</a> from <a href="https://www.flaticon.com/" title="Flaticon">www.flaticon.com</a></div>
86+
87+
<!-- CONTACT -->
88+
## Contact
89+
90+
[Simone Montali](https://monta.li) - [@Caffeina](https://caffeina.com)
91+
92+
Project Link: [https://github.com/caffeinalab/trelire](https://github.com/caffeinalab/trelire)
93+
94+
[screenshot]: res/screenshot.gif "Screenshot"
95+
[logo]: res/post-stamp.png

res/post-stamp.png

23.9 KB
Loading

res/screenshot.gif

1.08 MB
Loading

0 commit comments

Comments
 (0)