Skip to content

Commit

Permalink
readme
Browse files Browse the repository at this point in the history
  • Loading branch information
4kimov committed Feb 1, 2024
1 parent bcfa25f commit e9829a0
Showing 1 changed file with 41 additions and 12 deletions.
53 changes: 41 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,29 +3,37 @@
[![GoDoc](https://godoc.org/github.com/templateless/templateless-go?status.svg)](https://godoc.org/github.com/templateless/templateless-go)
[![Github Actions](https://img.shields.io/github/actions/workflow/status/templateless/templateless-go/tests.yml)](https://github.com/templateless/templateless-go/actions)

## What is this?
## What is Templateless?

[Templateless](https://templateless.com) lets you quickly create and send emails with your favorite email provider without ever leaving your code editor.
[Templateless](https://templateless.com) lets you generate and send transactional emails quickly and easily so you can ship faster 🚀

Don't waste time messing around with HTML or HTML builders.
## ✨ Features

**Get your free API key [here](https://app.templateless.com).**
- 👋 **Anti drag-and-drop by design** — emails are a part of your code
-**Components as code** — function calls turn into email HTML components
- 💻 **SDK for any language** — use your favorite [programming language](https://github.com/orgs/templateless/repositories)
- 🔍 **Meticulously tested** — let us worry about email client compatibility
- 💌 **Use your favorite ESP** — Amazon SES, SendGrid, Mailgun + more
- 💪 **Email infrastructure** — rate-limiting, retries, scheduling + more
-**Batch sending** — send 1 email or 1,000 with one API call

## Getting Started
## 🚀 Getting started

Use go get.
Use go get:

```bash
go get github.com/templateless/templateless-go
```

Then import the package into your own code.
Then import the package into your own code:

```go
import "github.com/templateless/templateless-go"
```

## Quick Example
## 👩‍💻 Quick example

This is all it takes to send a signup confirmation email:

```go
package main
Expand All @@ -38,13 +46,14 @@ import (

func main() {
content, _ := templateless.NewContent().
Text("Hello world").
Text("Hi, please **confirm your email**:").
Button("Confirm Email", "https://your-company.com/signup/confirm?token=XYZ").
Build()

emailAddress := templateless.NewEmailAddress("user@example.com")
emailAddress := templateless.NewEmailAddress("<YOUR_CUSTOMERS_EMAIL_ADDRESS>")
email, _ := templateless.NewEmail().
To(*emailAddress).
Subject("Hello 👋").
Subject("Confirm your signup 👋").
Content(*content).
Build()

Expand All @@ -55,6 +64,26 @@ func main() {
}
```

## License
Note:

1. Get your **free API key** here: <https://app.templateless.com>
1. There are more Go examples in the [examples](examples) folder

## 🤝 Contributing

- Contributions are more than welcome <3
- Please **star this repo** for more visibility ★

## 📫 Get in touch

- For customer support feel free to email us at [github@templateless.com](mailto:github@templateless.com)

- Have suggestions or want to give feedback? Here's how to reach us:

- For feature requests, please [start a discussion](https://github.com/templateless/templateless-go/discussions)
- Found a bug? [Open an issue!](https://github.com/templateless/templateless-go/issues)
- We are also on Twitter: [@Templateless](https://twitter.com/templateless)

## 🍻 License

[MIT](LICENSE)

0 comments on commit e9829a0

Please sign in to comment.