From a30300b77b557b5eacfe51b66fb38638ddf5e7d3 Mon Sep 17 00:00:00 2001 From: "Neidinger, Marcel" Date: Wed, 30 Oct 2019 19:42:35 +0100 Subject: [PATCH] Added readme and pushed to pypi --- README.md | 42 ++++++++---------------------------------- docs/installation.rst | 8 ++++---- setup.py | 2 +- 3 files changed, 13 insertions(+), 39 deletions(-) diff --git a/README.md b/README.md index bc0ca75..01b95ac 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ ## Introduction -[Adaptive Cards](https://adaptivecards.io/) are a great way to extend your bots interactions. However, writing the JSON required to specify the card layout by hand can be cumbersome and error prone. And while using a [designer](https://adaptivecards.io/designer/) is a good way for manually created cards this does not cover cards that are generated by code. PyAdaptiveCards allows you to author cards in native python without ever touching the underlying json. +[Adaptive Cards](https://adaptivecards.io/) are a great way to extend your bots interactions. However, writing the JSON required to specify the card layout by hand can be cumbersome and error prone. And while using a [designer](https://adaptivecards.io/designer/) is a good way to manually create cards this does not cover cards that are generated by code. PyAdaptiveCards allows you to author cards in native python without ever touching the underlying json. A code sample says more then a thousand words so the following code snippet ... @@ -71,44 +71,18 @@ print(card_json) ## Features -Include a succinct summary of the features/capabilities of your project. - -- Feature 1 -- Feature 2 -- Feature 3 - -## Technologies & Frameworks Used - -This is Cisco Sample Code! What Cisco and third-party technologies are you working with? Are you using a coding framework or software stack? A simple list will set the context for your project. - -**Cisco Products & Services:** - -- Product -- Service - -**Third-Party Products & Services:** - -- Product -- Service - -**Tools & Frameworks:** - -- Framework 1 -- Automation Tool 2 - -## Usage - -If people like your project, they will want to use it. Show them how. +- Supports all components, options and features of adaptive cards version 1.1 +- Create adaptive cards from pure python ## Installation -Provide a step-by-step series of examples and explanations for how to install your project and its dependencies. - -## Documentation +You can install PyAdaptiveCards using pip by issuing -Please check the project documentation at: +```bash +$ pip install pyadaptivecards +``` -https://pyadaptivecards.readthedocs.io +For more information on how to use this package please check the project documentation at https://pyadaptivecards.readthedocs.io. ## Authors & Maintainers diff --git a/docs/installation.rst b/docs/installation.rst index 142e49a..a56c8ca 100644 --- a/docs/installation.rst +++ b/docs/installation.rst @@ -32,13 +32,13 @@ You can either clone the public repository: .. code-block:: console - $ git clone git://github.com/sQu4rks/pyadaptivecards + $ git clone git://github.com/CiscoSE/pyadaptivecards Or download the `tarball`_: .. code-block:: console - $ curl -OL https://github.com/sQu4rks/pyadaptivecards/tarball/master + $ curl -OL https://github.com/CiscoSE/pyadaptivecards/tarball/master Once you have a copy of the source, you can install it with: @@ -47,5 +47,5 @@ Once you have a copy of the source, you can install it with: $ python setup.py install -.. _Github repo: https://github.com/sQu4rks/pyadaptivecards -.. _tarball: https://github.com/sQu4rks/pyadaptivecards/tarball/master +.. _Github repo: https://github.com/CiscoSE/pyadaptivecards +.. _tarball: https://github.com/CiscoSE/pyadaptivecards/tarball/master diff --git a/setup.py b/setup.py index 070cbde..c9b81a0 100644 --- a/setup.py +++ b/setup.py @@ -41,7 +41,7 @@ setup_requires=setup_requirements, test_suite='tests', tests_require=test_requirements, - url='https://github.com/sQu4rks/pyadaptivecards', + url='https://github.com/CiscoSE/pyadaptivecards', version='0.1.0', zip_safe=False, )