Added a basic README.md file

IntersectMBO · Jan 20, 2023 · c4e1847 · c4e1847
1 parent db072d0
commit c4e1847
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -0,0 +1,11 @@
+# `cardano-prelude`
+
+An alternative prelude based on [`protolude`] used by projects in the `cardano`
+ecosystem.  Some projects use it as their default prelude (using
+`NoImplicitPrelude`), othes just import specific functions from it.
+
+If you'd like to contribute see [CONTRIBUTING.md]. We also have a [code of conduct].
+
+[CONTRIBUTING.md]: https://github.com/input-output-hk/cardano-prelude/blob/master/CONTRIBUTING.md 
+[code of conduct]:  https://github.com/input-output-hk/cardano-prelude/blob/master/CODE-OF-CONDUCT.md
+[`protolude`]: https://hackage.haskell.org/package/protolude