about summary refs log tree commit diff
path: root/net/crimp/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'net/crimp/README.md')
-rw-r--r--net/crimp/README.md26
1 files changed, 26 insertions, 0 deletions
diff --git a/net/crimp/README.md b/net/crimp/README.md
new file mode 100644
index 0000000000..65a9d4293b
--- /dev/null
+++ b/net/crimp/README.md
@@ -0,0 +1,26 @@
+crimp
+=====
+
+[![](https://img.shields.io/crates/v/crimp.svg)](https://crates.io/crates/crimp)
+[![](https://docs.rs/crimp/badge.svg)](https://docs.rs/crimp)
+
+Crimp is an HTTP client interface on top of the [Rust bindings][] to
+cURL.
+
+The documentation for this crate is primarily in the [module
+documentation][]
+
+-------
+
+This project is developed in the [TVL monorepo][depot]. To work on it,
+you can either use a local clone of the entire repository or clone
+just the `crimp` subtree:
+
+    https://code.tvl.fyi/depot.git:/net/crimp.git
+
+Please follow the TVL [contribution guidelines][contributing].
+
+[Rust bindings]: https://docs.rs/curl
+[module documentation]: https://docs.rs/crimp
+[depot]: https://code.tvl.fyi/
+[contributing]: https://code.tvl.fyi/about/docs/CONTRIBUTING.md