From f9da6efec262f8b93d35a072ea3f8dbee8632f1d Mon Sep 17 00:00:00 2001
From: Shailesh Kumar <shaileshk@gmail.com>
Date: Sat, 27 Aug 2022 15:39:28 +0530
Subject: [PATCH] README updates

---
 .gitignore |  2 ++
 README.md  | 42 ++++++++++++++++++++++++++++++++++++++++--
 2 files changed, 42 insertions(+), 2 deletions(-)

diff --git a/.gitignore b/.gitignore
index 9585ae1..10c706b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -160,3 +160,5 @@ docs/gallery/
 # airspeed velocity benchmark results
 .asv/*
 paper/paper.pdf
+
+*.html
diff --git a/README.md b/README.md
index b013a61..af8d611 100644
--- a/README.md
+++ b/README.md
@@ -1,5 +1,43 @@
-# cr-nimble
-Iterative algorithms for numerical linear algebra with JAX
+# CR-Nimble
+
+`CR-Nimble` consists of fast linear algebra
+and signal processing routines.
+Most of the routines have been implemented using
+Google JAX. Thus, they can be easily run on
+a variety of hardware (CPU, GPU, TPU).
+
+Functionality includes:
+
+* Utility functions for working with vectors, matrices and arrays
+* Linear algebra functions
+* Digital signal processing functions
+* Data compression functions
+* Test data generation functions
+
+
+Installation
+
+```{shell}
+python -m pip install cr-nimble
+```
+
+Import
+
+```{python}
+import cr.nimble as crn
+```
+
+See [documentation](https://cr-nimble.readthedocs.io)
+for library usage.
+
+`CR-Nimble` is part of
+[CR-Suite](https://carnotresearch.github.io/cr-suite/).
+
+Related libraries:
+
+* [CR-Wavelets](https://cr-wavelets.readthedocs.io)
+* [CR-Sparse](https://cr-sparse.readthedocs.io)
+
 
 [![codecov](https://codecov.io/gh/carnotresearch/cr-nimble/branch/main/graph/badge.svg?token=PX1MGTZ7VL)](https://codecov.io/gh/carnotresearch/cr-nimble) 
 [![Unit Tests](https://github.com/carnotresearch/cr-nimble/actions/workflows/ci.yml/badge.svg)](https://github.com/carnotresearch/cr-nimble/actions/workflows/ci.yml)