Skip to content
This repository has been archived by the owner on Mar 23, 2021. It is now read-only.

Commit

Permalink
docs: minor improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
upsetbit committed Oct 6, 2018
1 parent 98c5a46 commit 2cb0960
Show file tree
Hide file tree
Showing 3 changed files with 70 additions and 70 deletions.
70 changes: 0 additions & 70 deletions README.rst

This file was deleted.

1 change: 1 addition & 0 deletions README.rst
69 changes: 69 additions & 0 deletions docs/README.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
.. image:: https://travis-ci.org/caianrais/dora.svg?branch=master
:target: https://travis-ci.org/caianrais/dora
:alt: Build Status

.. image:: https://codecov.io/gh/caianrais/dora/branch/master/graph/badge.svg
:target: https://codecov.io/gh/caianrais/dora
:alt: Code Coverage Status

.. image:: https://readthedocs.org/projects/dora/badge/?version=latest
:target: https://dora.readthedocs.io
:alt: Documentation Status

.. image:: https://img.shields.io/github/license/caianrais/dora.svg
:target: https://github.com/caianrais/dora/blob/master/LICENSE
:alt: License Information


***********************
DORA: DNS Over REST API
***********************

``DORA`` is a microservice that provides a simple API for DNS querying through
a REST architecture. It aims to be a consumable API that's easy to digest and
easy to deploy on cloud-based solutions, such as `AWS Lambda`_, `GCP Cloud
Functions`_, `GCP AppEngine`_, `Heroku`_ and so on.

.. image:: docs/example.png

.. _AWS Lambda: https://aws.amazon.com/lambda/
.. _GCP Cloud Functions: https://cloud.google.com/functions/
.. _GCP AppEngine: https://cloud.google.com/appengine/
.. _Heroku: https://www.heroku.com/


Features
========

DORA mainly relies on the ``dnspython`` toolkit. It can query the following
records:

- ``A``: IPv4 address;
- ``AAAA``: IPv6 address;
- ``CNAME``: Canonical name (name alias);
- ``MX``: Mail exchange (mail transfer agent name);
- ``NS``: Authoritative name server;
- ``TXT``: Text records.


Documentation
=============

For instructions of usage, installation, deployment and overall documentation
of the code, `read the docs`_.

.. _read the docs: http://dora.rtfd.io


TODO
====

- Finish the user documentation;
- Create code documentation;
- 100% covered (*write tests*);
- Publish DORA on PyPI;
- Dockerized DORA;
- Guide: Deploying DORA on Heroku;
- Guide: Deploying DORA on AWS Lambda;
- Guide: Deploying DORA on Google App Engine;
- Guide: Deploying DORA on Google Cloud Functions;
Binary file added docs/example.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 2cb0960

Please sign in to comment.