From 19e5c60ba2a0ab2fc1def76341eb6a3d312d66ee Mon Sep 17 00:00:00 2001
From: Pavel <pashok9825@gmail.com>
Date: Wed, 18 Sep 2019 14:05:06 +0300
Subject: [PATCH] update README.md

---
 README.md | 85 ++++++++++++++++++++++++++++++++++++++++++++++++++++++-
 1 file changed, 84 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index ac2e164..d283560 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,86 @@
 ## MG Transport Library
 
-This library provides different functions like error-reporting, logging, localization, etc. in order to make it easier to create transports
+This library provides different functions like error-reporting, logging, localization, etc. in order to make it easier to create transports.   
+Usage:
+```go
+package main
+
+import (
+    "os"
+    "fmt"
+    "html/template"
+
+    "github.com/gin-gonic/gin"
+    "github.com/gobuffalo/packr/v2"
+    "github.com/retailcrm/mg-transport-core/core"
+)
+
+func main() {
+    app := core.New()
+    app.Config = core.NewConfig("config.yml")
+    app.DefaultError = "unknown_error"
+    app.TranslationsPath = "./translations"
+    
+    app.ConfigureRouter(func(engine *gin.Engine) {
+        engine.Static("/static", "./static")
+        engine.HTMLRender = app.CreateRenderer(
+            func(renderer *core.Renderer) {
+                // insert templates here. Example:
+                r.Push("home", "templates/layout.html", "templates/home.html")
+            }, 
+            template.FuncMap{},
+        )
+    })
+    
+    if err := app.Prepare().Run(); err != nil {
+        fmt.Printf("Fatal error: %s", err.Error())
+        os.Exit(1)
+    }
+}
+```
+
+### Resource embedding
+[packr](https://github.com/gobuffalo/packr/tree/master/v2) can be used to provide resource embedding. In order to use packr you must follow
+[this instruction](https://github.com/gobuffalo/packr/tree/master/v2#library-installation), and provide boxes with templates,
+translations and assets to library. Example:
+```go
+package main
+
+import (
+    "os"
+    "fmt"
+    "html/template"
+
+    "github.com/gin-gonic/gin"
+    "github.com/gobuffalo/packr/v2"
+    "github.com/retailcrm/mg-transport-core/core"
+)
+
+func main() {
+    static := packr.New("assets", "./static")
+    templates := packr.New("templates", "./templates")
+    translations := packr.New("translations", "./translate")
+    
+    app := core.New()
+    app.Config = core.NewConfig("config.yml")
+    app.DefaultError = "unknown_error"
+    app.TranslationsBox = translations
+    
+    app.ConfigureRouter(func(engine *gin.Engine) {
+        engine.StaticFS("/static", static)
+        engine.HTMLRender = app.CreateRendererFS(
+            templates, 
+            func(renderer *core.Renderer) {
+                // insert templates here. Example:
+                r.Push("home", "layout.html", "home.html")
+            }, 
+            template.FuncMap{},
+        )
+    })
+    
+    if err := app.Prepare().Run(); err != nil {
+        fmt.Printf("Fatal error: %s", err.Error())
+        os.Exit(1)
+    }
+}
+```
\ No newline at end of file