🚚 Moved docs to repository root

This commit is contained in:
Maxim Lebedev 2019-07-24 12:58:51 +05:00
parent 6144681a17
commit f5f59beb39
No known key found for this signature in database
GPG Key ID: F8978F46FF0FFA4F
5 changed files with 19 additions and 26 deletions

View File

@ -1,5 +1,5 @@
# MIT License
Copyright (c) 2018 Maxim Lebedev
Copyright (c) 2019 Maxim Lebedev
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal

18
README.md Normal file
View File

@ -0,0 +1,18 @@
# GoLang bindings for the Telegraph API [![discord](https://discordapp.com/api/guilds/208605007744860163/widget.png)](https://discord.gg/QJ8z5BN)
> This project is just to provide a wrapper around the API without any additional features.
All [methods](https://toby3d.github.io/telegraph/#available-methods) and [types](https://toby3d.github.io/telegraph/#available-types) available and this library (possibly) is ready for use in production. Yaay!
## Start using telegraph
Download and install it:
`$ go get -u gitlab.com/toby3d/telegraph`
Import it in your code:
`import "gitlab.com/toby3d/telegraph"`
## Examples
See [GoDoc examples section](https://godoc.org/gitlab.com/toby3d/telegraph#pkg-examples) or check [example_test.go](/example_test.go).
## Need help?
- [Open new issue](https://gitlab.com/toby3d/telegraph/issues/new)
- [Discuss in Discord](https://discord.gg/QJ8z5BN)

View File

@ -1,25 +0,0 @@
# GoLang bindings for the Telegraph API [![discord](https://discordapp.com/api/guilds/208605007744860163/widget.png)](https://discord.gg/QJ8z5BN)
> This project is just to provide a wrapper around the API without any additional features.
[![License](https://img.shields.io/npm/l/express.svg?maxAge=2592000)](LICENSE.md)
[![Build Status](https://travis-ci.org/toby3d/telegraph.svg)](https://travis-ci.org/toby3d/telegraph)
[![GoDoc](https://godoc.org/github.com/toby3d/telegraph?status.svg)](https://godoc.org/github.com/toby3d/telegraph)
[![Go Report](https://goreportcard.com/badge/github.com/toby3d/telegraph)](https://goreportcard.com/report/github.com/toby3d/telegraph)
[![Patreon](https://img.shields.io/badge/support-patreon-E6461A.svg?maxAge=2592000)](https://www.patreon.com/toby3d)
[![Awesome](https://cdn.rawgit.com/sindresorhus/awesome/d7305f38d29fed78fa85652e3a63e154dd8e8829/media/badge.svg)](https://github.com/avelino/awesome-go)
All [methods](https://toby3d.github.io/telegraph/#available-methods) and [types](https://toby3d.github.io/telegraph/#available-types) available and this library (possibly) is ready for use in production. Yaay!
## Start using telegraph
Download and install it:
`$ go get -u github.com/toby3d/telegraph`
Import it in your code:
`import "github.com/toby3d/telegraph"`
## Examples
See [GoDoc examples section](https://godoc.org/github.com/toby3d/telegraph#pkg-examples) or check [example_test.go](/example_test.go).
## Need help?
- [Open new issue](https://github.com/toby3d/telegraph/issues/new)
- [Discuss in Discord](https://discord.gg/QJ8z5BN)