Updated README and Sphinx documentation

Author: Ben Davis

README.md

@@ -1,8 +1,50 @@
 # FastSandPM
-A package management and dependency resolution tool for HDL Design and DV projects
+An RTL Design and DV package manager for python tools. Manage your RTL and
+design verification library dependencies by cloning, updating, and
+version-controlling git repositories.
 
 [![Tests](https://github.com/RISCY-Lib/fastsandpm/actions/workflows/run-ci-tests.yml/badge.svg)](https://github.com/RISCY-Lib/fastsandpm/actions/workflows/run-ci-tests.yml)
 [![PyPI Latest Release](https://img.shields.io/pypi/v/fastsandpm.svg)](https://pypi.org/project/fastsandpm/)
 [![docs](https://readthedocs.org/projects/fastsandpm/badge)](https://fastsandpm.readthedocs.io/en/latest/index.html)
 
 See [Read-The-Docs](https://fastsandpm.readthedocs.io/en/latest/index.html) for details
+
+Key Features
+------------
+
+- **Library Management**: Clone and update RTL/DV libraries from git repositories
+- **Version Pinning**: Pin libraries to specific tags, branches, or commits
+- **Version Ranges**: Specify flexible version constraints (e.g., ``>=1.0.0,<2.0.0``)
+- **TOML Configuration**: Organize libraries in configuration files with sub-headings
+- **Local Development**: Symlink local directories for development workflows
+- **Multi-Remote Support**: Automatically discover repositories across configured remotes
+
+Quick Start
+-----------
+
+Installation:
+
+.. code-block:: bash
+
+   # For UV Based projects
+   uv add fastsandpm
+
+   # For pip-based projects
+   pip install fastsandpm
+
+Basic Usage:
+
+    >>> import pathlib
+    >>> import fastsandpm
+    >>> manifest = fastsandpm.get_manifest("./my-project")
+    >>> print(manifest.package.name)
+    'my-package'
+    >>> resolved = fastsandpm.dependencies.resolve(manifest)
+    >>> print(type(resolved))
+    <class 'dict'>
+    >>> build_library(resolved, pathlib.Path("my-library"))
+
+This will bring in the library dependencies for a project into the specified directory.
+Additionally, a 'dependencies.f' file will be created which will point to the dependencies file list in the required order.
+
+For more examples, see [the docs](https://fastsandpm.readthedocs.io/en/latest/usage_guide/index.html) for details.

docs/source/index.rst

@@ -1,6 +1,7 @@
 .. fastsandpm documentation master file
 
 fastsandpm Documentation
+
 ===========================================
 
 An RTL Design and DV package manager for python tools. Manage your RTL and
@@ -32,19 +33,15 @@ Installation:
 
 Basic Usage:
 
-.. code-block:: python
-
-   import pathlib
-   import fastsandpm
-
-   # Get the manifest of the current project
-   manifest = fastsandpm.get_manifest(pathlib.Path("some/repo/path"))
-
-   # Resolve the libraries
-   deps = fastsandpm.resolve_dependencies(manifest.dependencies, manifest.optional_dependencies["dev"])
-
-   # Update the libraries
-   fastsandpm.update_deps(libraries, pathlib.Path("some/library/.path"))
+    >>> import pathlib
+    >>> import fastsandpm
+    >>> manifest = fastsandpm.get_manifest("./my-project")
+    >>> print(manifest.package.name)
+    'my-package'
+    >>> resolved = fastsandpm.dependencies.resolve(manifest)
+    >>> print(type(resolved))
+    <class 'dict'>
+    >>> build_library(resolved, pathlib.Path("my-library"))
 
 This will bring in the library dependencies for a project into the specified directory.
 Additionally, a 'dependencies.f' file will be created which will point to the dependencies file list in the required order.

docs/source/usage_guide/index.rst

@@ -23,4 +23,6 @@ Or with pip:
 Basic Usage
 -----------
 
+.. NOTE::
 
+   TODO: Work in progress