README: Expand documentation to include an overview of repo contents
Change-Id: Id719a64f69de8cb5d08efc8c7d1b654790bb32fb
Signed-off-by: William A. Kennington III <wak@google.com>
diff --git a/README.md b/README.md
index e00530a..bc9991b 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,14 @@
# stdplus
stdplus is a c++ project containing commonly used classes and functions
-for the Linux platform.
+for the Linux platform. Note the goals of this project are to implement only
+the minimum set of features needed by the OpenBMC project and other users. You
+may find the included set of functions currently quite sparse.
+
+This project provides the following primitives:
+* A [movable](src/stdplus/handle/managed.hpp) and [copyable](src/stdplus/handle/copyable.hpp) RAII helper wrapper which is used for wrapping c-native types that have custom destruction or copy reference logic.
+* [Functions](src/stdplus/signal.hpp) for trivially configuring signals without having to do the normal signal set operations from libc
+* [C-Style Error Handler](src/stdplus/util/cexec.hpp) that wrap c-style functions which return errnos and negative error values into functions that throw c++ exceptions.
## Dependencies