Commit 85318ead authored by Lasse Schuirmann's avatar Lasse Schuirmann

Add landing page

parent cb8aed0e
Pipeline #19165013 canceled with stages
in 24 seconds
......@@ -28,7 +28,7 @@ how to set labels on a GitHub issue::
For more documentation you'll have to check the documentation comments for now.
More docs coming soon :)
More docs are available at `IGitt.GitMate.io <https://igitt.gitmate.io/>`_.
What About the Name?
--------------------
......
Welcome to IGitt's documentation!
=================================
Welcome to IGitt!
=================
.. image:: _static/logo_256.png
IGitt is a Git hoster abstraction. It is one python API that allows you to rule
over GitHub, GitLab and more hosting platforms.
Hey there! You're in the right place if you want to develop IGitt itself!
Why do I Need This?
-------------------
If you want to support more than one hoster it doesn't mean that you want to
implement all your API requests multiple times. With IGitt you can create e.g.
a ``GitHubIssue`` object and use it the same way as a ``GitLabIssue`` object.
Stop worrying about multiple platforms :)
Installation
------------
::
pip install IGitt
Quickstart
----------
All classes follow the APIs given in `IGitt.Interfaces`. Here's an example on
how to set labels on a GitHub issue::
from IGitt.GitHub.GitHubIssue import GitHubToken, GitHubIssue
issue = GitHubIssue(GitHubToken("YOUR TOKEN"), "ORG/REPO", NUMBER)
issue.labels = {"type/bug", "area/core"}
API Documentation
-----------------
.. toctree::
:caption: Home
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment