Merge branch 'dev'

.gitignore

@@ -1,7 +1,67 @@
-build/
-bld/
-build-vs/
-build-vs17/
-x64/
-structure
+
+# Created by https://www.gitignore.io/api/c
+
+### C ###
+# Prerequisites
+*.d
+
+# Object files
+*.o
+*.ko
+*.obj
+*.elf
+
+# Linker output
+*.ilk
+*.map
+*.exp
+
+# Precompiled Headers
+*.gch
+*.pch
+
+# Libraries
+*.lib
+*.a
+*.la
+*.lo
+
+# Shared objects (inc. Windows DLLs)
+*.dll
+*.so
+*.so.*
+*.dylib
+
+# Executables
+*.exe
+*.out
+*.app
+*.i*86
+*.x86_64
+*.hex
+
+# Debug files
+*.dSYM/
+*.su
+*.idb
+*.pdb
+
+# Kernel Module Compile Results
+*.mod*
+*.cmd
+.tmp_versions/
+modules.order
+Module.symvers
+Mkfile.old
+dkms.conf
+
+
+# End of https://www.gitignore.io/api/c
+
+build/
+bld/
+build-vs/
+build-vs17/
+x64/
+structure
 .vscode/

.travis.yml

@@ -22,7 +22,9 @@ deploy:
   file_glob: true
   file: $TRAVIS_BUILD_DIR/README.md
   skip_cleanup: true
-  before_deploy:
+
+  before_release:
+
     - ls -LR
   on:
     repo: giancarlopro/framebot

README.md

@@ -1,4 +1,4 @@
-# Framebot - 0.1.0 [![Build Status](https://travis-ci.org/giancarlopro/framebot.svg?branch=dev)](https://travis-ci.org/giancarlopro/framebot) [![Open Source Helpers](https://www.codetriage.com/giancarlopro/framebot/badges/users.svg)](https://www.codetriage.com/giancarlopro/framebot)
+# Framebot - 0.1.0 [![Build Status](https://travis-ci.org/giancarlopro/framebot.svg?branch=dev)](https://travis-ci.org/giancarlopro/framebot) [![Open Source Helpers](https://www.codetriage.com/giancarlopro/framebot/badges/users.svg)](https://www.codetriage.com/giancarlopro/framebot) [![Documentation Status](https://readthedocs.org/projects/framebot/badge/?version=latest)](http://framebot.readthedocs.io/pt/latest/?badge=latest)
 
 This is the official repository for Framebot.
 

docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS    =
+SPHINXBUILD   = sphinx-build
+SPHINXPROJ    = Framebot
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

docs/_build/html/.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: f7e70013576fda49f28e4114e47e33ff
+tags: 645f666f9bcd5a90fca523b33c5a78b7

docs/_build/html/_sources/index.rst.txt

@@ -0,0 +1,21 @@
+.. Framebot documentation master file, created by
+   sphinx-quickstart on Sat Feb 24 20:48:01 2018.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to Framebot's documentation!
+====================================
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Contents:
+
+   starting
+
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/_build/html/_sources/starting.rst.txt

@@ -0,0 +1,53 @@
+Começando
+=========
+
+Framebot é uma biblioteca feita em C para facilitar o uso da BOT API do telegram.
+
+Instalação
+----------
+
+Para instalar a biblioteca você deve primeiro clonar o nosso repositório:
+    ``$ git clone https://github.com/giancarlopro/framebot``
+
+Agora você vai precisar ter o `cmake` instalado, e algumas libs:
+    ``$ sudo apt install cmake openssl curl jansson``
+
+Após isso entre na pasta onde a biblioteca foi clonada, por padrão vai ser `framebot`:
+    ``$ cd framebot``
+
+Agora crie uma pasta para compilar a biblioteca e rode o cmake para criar o makefile:
+    ``$ mkdir build``
+
+    ``$ cd build``
+
+    ``$ cmake ..``
+
+Agora utilize o makefile para compilar e instalar a biblioteca:
+    ``$ make``
+
+    ``$ make install``
+
+Configuração
+------------
+
+Para utilizar a biblioteca em seus projetos, você deve informar ao compilador explicitamente
+as bibliotecas que serão compiladas juntas.
+
+* Se estiver compilando pelo terminal:
+    ``$ gcc projeto.c -o out -lcurl -ljansson -lframebot``
+
+* Se estiver utilizando o cmake basta informar no seu CMakeLists.txt, em target_link_libraries:
+    ``target_link_libraries(seuexecutavel framebot)``
+
+Utilização
+----------
+
+Para utilizar a biblioteca em seus projetos, você deve incluir o arquivo `framebot.h`.
+    ``#include <framebot/framebot.h>``
+
+Exemplos
+--------
+
+Você encontra exemplos de uso da biblioteca na pasta `examples` em nosso repositório no `GitHub`_.
+
+.. _`GitHub`: https://github.com/giancarlopro/framebot/blob/master/examples