feature: add settings, update logic, add docs

README.md

@@ -2,39 +2,38 @@
 
 # ckanext-tour
 
-**TODO:** Put a description of your extension here:  What does it do? What features does it have? Consider including some screenshots or embedding a video!
+ckanext-tour is a CKAN extension that provides a guided tour feature for CKAN instances. It allows users to create interactive tours to showcase different features and functionalities of a CKAN instance.
 
+## Features
+- Create interactive tours with step-by-step instructions
+- Highlight specific elements on CKAN pages
+- Customize tour appearance and behavior
+- Easily manage and edit tours through the CKAN admin interface
 
-## Requirements
+Once the extension is installed and enabled, you can start creating tours through the CKAN admin interface. Tours can be associated with specific pages or sections of your CKAN portal, and you can define multiple steps for each tour.
+
+To start a tour, users can click on a tour trigger button or it can be started automatically, when user visits the specified page. The tour will guide them through the specified steps, highlighting the relevant elements on each page.
+
+Each step contains next information:
 
-**TODO:** For example, you might want to mention here which versions of CKAN this
-extension works with.
+- Title: A brief, engaging headline that summarizes the step.
+- Query: Query to specify which element we're highlighting
+- Intro: Text, that will be displayed on a step card
+- Position: Specifies the placement of step card (top, right, bottom, left).
+- Image: Visuals to complement the text, illustrate points, or add visual interest. GIF animation could be used here.
 
-If your extension works across different versions you can add the following table:
+## Requirements
 
 Compatibility with core CKAN versions:
 
 | CKAN version    | Compatible?   |
 | --------------- | ------------- |
-| 2.6 and earlier | not tested    |
-| 2.7             | not tested    |
-| 2.8             | not tested    |
 | 2.9             | not tested    |
-
-Suggested values:
-
-* "yes"
-* "not tested" - I can't think of a reason why it wouldn't work
-* "not yet" - there is an intention to get it working
-* "no"
+| 2.10+           | yes           |
 
 
 ## Installation
 
-**TODO:** Add any additional install steps to the list below.
-   For example installing any non-Python dependencies or adding any required
-   config settings.
-
 To install ckanext-tour:
 
 1. Activate your CKAN virtual environment, for example:
@@ -59,18 +58,11 @@ To install ckanext-tour:
 
 ## Config settings
 
-None at present
-
-**TODO:** Document any optional config settings here. For example:
-
-	# The minimum number of hours to wait before re-checking a resource
-	# (optional, default: 24).
-	ckanext.tour.some_setting = some_default_value
-
+To modify the configuration of the extension, please make the changes through the site's user interface.
 
 ## Developer installation
 
-To install ckanext-tour for development, activate your CKAN virtualenv and
+To install `ckanext-tour` for development, activate your CKAN virtualenv and
 do:
 
     git clone https://github.com/mutantsan/ckanext-tour.git
@@ -86,38 +78,6 @@ To run the tests, do:
     pytest --ckan-ini=test.ini
 
 
-## Releasing a new version of ckanext-tour
-
-If ckanext-tour should be available on PyPI you can follow these steps to publish a new version:
-
-1. Update the version number in the `setup.py` file. See [PEP 440](http://legacy.python.org/dev/peps/pep-0440/#public-version-identifiers) for how to choose version numbers.
-
-2. Make sure you have the latest version of necessary packages:
-
-    pip install --upgrade setuptools wheel twine
-
-3. Create a source and binary distributions of the new version:
-
-       python setup.py sdist bdist_wheel && twine check dist/*
-
-   Fix any errors you get.
-
-4. Upload the source distribution to PyPI:
-
-       twine upload dist/*
-
-5. Commit any outstanding changes:
-
-       git commit -a
-       git push
-
-6. Tag the new release of the project on GitHub with the version number from
-   the `setup.py` file. For example if the version number in `setup.py` is
-   0.0.1 then do:
-
-       git tag 0.0.1
-       git push --tags
-
 ## License
 
 [AGPL](https://www.gnu.org/licenses/agpl-3.0.en.html)