From 50ed2bdda9a0e657215e640978ca4526a1883cc2 Mon Sep 17 00:00:00 2001 From: davebshow <davebshow@gmail.com> Date: Fri, 19 Jan 2018 10:37:28 -0800 Subject: [PATCH] updated project description in docs --- README.md | 5 ++--- docs/index.rst | 5 ++--- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 6929d1c..3702283 100644 --- a/README.md +++ b/README.md @@ -2,14 +2,13 @@ [Official Documentation](http://aiogremlin.readthedocs.org/en/latest/) -`aiogremlin` is a port of the official `Gremlin-Python` designed for integration with +`aiogremlin` is an asynchronous DSL based on the official `Gremlin-Python` GLV designed for integration with event loop based asynchronous Python networking libraries, including `asyncio`, `aiohttp`, and `tornado`. It uses the `async/await` syntax introduced in PEP 492, and is therefore Python 3.5+ only. `aiogremlin` tries to follow `Gremlin-Python` as closely as possible both in terms -of API and implementation. It is regularly rebased against the official Apache Git -repository, and will be released according to the TinkerPop release schedule. +of API and implementation. It is released according to the TinkerPop release schedule. Note that this *NOT* an official Apache project component, it is a *THIRD PARTY PACKAGE!* diff --git a/docs/index.rst b/docs/index.rst index 9ac945c..76d45f8 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -7,14 +7,13 @@ aiogremlin ========== -`aiogremlin` is a port of the official `Gremlin-Python` designed for integration with +`aiogremlin` is an asynchronous DSL based on the official `Gremlin-Python` GLV designed for integration with event loop based asynchronous Python networking libraries, including `asyncio`_, `aiohttp`_, and `tornado`_. It uses the `async/await` syntax introduced in `PEP 492`_, and is therefore Python 3.5+ only. `aiogremlin` tries to follow `Gremlin-Python` as closely as possible both in terms -of API and implementation. It is regularly rebased against the official Apache Git -repository, and will be released according to the `TinkerPop`_ release schedule. +of API and implementation. It is released according to the `TinkerPop`_ release schedule. Note that this *NOT* an official Apache project component, it is a *THIRD PARTY PACKAGE!* -- GitLab