From c359515270c6ffbbf0099a6b245223c200e0f893 Mon Sep 17 00:00:00 2001
From: Kiana Sheibani <kiana.a.sheibani@gmail.com>
Date: Fri, 21 Oct 2022 18:48:02 -0400
Subject: [PATCH] Update README.md

---
 README.md | 30 ++++++++++++++++++++++++++++++
 1 file changed, 30 insertions(+)

diff --git a/README.md b/README.md
index 9b01bd1..e378d29 100644
--- a/README.md
+++ b/README.md
@@ -6,3 +6,33 @@ vector spaces and matrices. It borrows concepts heavily from Python's [NumPy](ht
 as well as Rust's [nalgebra](https://www.nalgebra.org/).
 
 The name is pronounced like "num-idge".
+
+## Features
+
+- A type-safe and efficient array type, based on NumPy's arrays.
+
+- Compile-time checked indexing operations to avoid run-time overhead.
+
+- Utility functions and operations for working with vectors, matrices,
+  homogeneous coordinates, and other linear algebra computations.
+
+- Transform types for working with rotations, reflections, isometries, and other
+  types of affine maps.
+
+## Planned Features
+
+- An IO-based mutable array type, useful for writing more efficient code.
+
+## Documentation
+
+Most of the exported utility functions have docstrings. There are also plans for
+an in-depth tutorial on NumIdr's features, though that is not available yet.
+
+## Usage
+
+Basic package install:
+
+``` shell
+idris2 --install numidr.ipkg
+```
+