diff --git a/README_PYPI.md b/README_PYPI.md new file mode 100644 index 0000000..0c29e48 --- /dev/null +++ b/README_PYPI.md @@ -0,0 +1,9 @@ +# PyDTNsim + +## Introduction + +This python module contains a simulation environment that allows the simulation of arbitrary Delay Tolerant Networking (DTN) scenarios on a packet (DTN terminology: bundle) level. *PyDTNsim* provides users with the ability to evaluate the performance of various routing approaches and to detect possibly occurring overload situations. Currently, the focus lies on deterministic Contact-Graph-based routing approaches, but there might be other +approaches available in the future. The clear modularization allows users to easily implement routing approaches on their own. + +## More Information +Please refer to the Github repository for a more detailed overview of the module and tutorials on how to get started. diff --git a/setup.py b/setup.py index 779b609..74feeff 100644 --- a/setup.py +++ b/setup.py @@ -4,7 +4,7 @@ from setuptools import setup # Read the README as long description (used with pypi) -with open("README.md", "r") as fh: +with open("README_PYPI.md", "r") as fh: long_description = fh.read() setup( @@ -16,7 +16,7 @@ long_description=long_description, long_description_content_type="text/markdown", license='MIT', - keywords="dtn, cgr", + keywords="delay-tolerant-networking, routing, simulation, dtn, cgr", url="https://github.com/ducktec/pydtnsim", python_requires='>=3.7.0', packages=setuptools.find_packages(),