DOC: write the readme file

Author: dmgav

LICENSE

@@ -1,6 +1,6 @@
 BSD 3-Clause License
 
-Copyright (c) 2025, My Name.
+Copyright (c) 2025.
 All rights reserved.
 
 Redistribution and use in source and binary forms, with or without

README.md

@@ -1,27 +1,61 @@
 # save-and-restore-api
 
-[![Actions Status][actions-badge]][actions-link]
-[![Documentation Status][rtd-badge]][rtd-link]
-
-[![PyPI version][pypi-version]][pypi-link]
-[![Conda-Forge][conda-badge]][conda-link]
-[![PyPI platforms][pypi-platforms]][pypi-link]
-
-[![GitHub Discussion][github-discussions-badge]][github-discussions-link]
-
-<!-- SPHINX-START -->
-
-<!-- prettier-ignore-start -->
-[actions-badge]:            https://github.com/dmgav/save-and-restore-api/workflows/CI/badge.svg
-[actions-link]:             https://github.com/dmgav/save-and-restore-api/actions
-[conda-badge]:              https://img.shields.io/conda/vn/conda-forge/save-and-restore-api
-[conda-link]:               https://github.com/conda-forge/save-and-restore-api-feedstock
-[github-discussions-badge]: https://img.shields.io/static/v1?label=Discussions&message=Ask&color=blue&logo=github
-[github-discussions-link]:  https://github.com/dmgav/save-and-restore-api/discussions
-[pypi-link]:                https://pypi.org/project/save-and-restore-api/
-[pypi-platforms]:           https://img.shields.io/pypi/pyversions/save-and-restore-api
-[pypi-version]:             https://img.shields.io/pypi/v/save-and-restore-api
-[rtd-badge]:                https://readthedocs.org/projects/save-and-restore-api/badge/?version=latest
-[rtd-link]:                 https://save-and-restore-api.readthedocs.io/en/latest/?badge=latest
-
-<!-- prettier-ignore-end -->
+Python package for communicating with Save-and-Restore service (CSS Phoebus). The
+package provides syncronous (thread-based) and asynchronous (asyncio) versions of
+the API functions.
+
+## Examples
+
+The following code creates a folder node named "My Folder" under the root node:
+
+```python
+
+    from save_and_restore_api import SaveRestoreAPI
+
+    with SaveRestoreAPI(base_url="http://localhost:8080/save-restore") as SR:
+        SR.auth_set(username="user", password="user_password")
+
+        root_folder_uid = SR.ROOT_NODE_UID
+        node={"name": "My Folder", "nodeType": "FOLDER"}
+
+        folder = SR.node_add(root_folder_uid, node=node)
+
+        print(f"Created folder metadata: {folder}")
+```
+
+Async version of the same code:
+
+```python
+
+    from save_and_restore_api.aio import SaveRestoreAPI
+
+    async with SaveRestoreAPI(base_url="http://localhost:8080/save-restore") as SR:
+        await SR.auth_set(username="user", password="user_password")
+
+        root_folder_uid = SR.ROOT_NODE_UID
+        node={"name": "My Folder", "nodeType": "FOLDER"}
+
+        folder = await SR.node_add(root_folder_uid, node=node)
+        print(f"Created folder metadata: {folder}")
+```
+
+
+## `save-and-restore` CLI Tool
+
+The package also contains simple CLI tool (`save-and-restore`) for performing a small
+set of basic operations on the nodes of the Save-and-Restore service. The tool was
+primarily developed for creating snapshot configurations based on lists of PVs.
+For example, the tool can read a list of PVs from a .sav file generated by IOC autosave
+and create a configuration node based on that list. Currently only autosave files
+are supported, but support for other formats can be added if needed. The list of
+supported functions can also be extended. Current functions are:
+
+- LOGIN: test login credentials;
+
+- CONFIG ADD: create configuration node based on a list of PVs read from a file;
+
+- CONFIG UPDATE: update an existing configuration node based on a list of PVs read from a file;
+
+- CONFIG GET: get information about an existing configuration node, including the list of PVs.
+
+Use `save-and-restore -h` to see the list of options.

docs/source/index.rst

@@ -3,8 +3,8 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Bluesky Queue Server API Documentation
-======================================
+Save and Restore API Documentation
+==================================
 
 .. toctree::
    :maxdepth: 2

docs/source/installation.rst

@@ -5,7 +5,3 @@ Installation
 Installation from PyPI::
 
     $ pip install save-and-restore-api
-
-Installation from `conda-forge`::
-
-    $ conda install save-and-restore-api -c conda-forge