docs: Update README with more interesting information r/230

1 files changed, 52 insertions, 5 deletions

diff --git a/README.md b/README.md
index 1dcadb3b2b24..d3537bfff722 100644
--- a/README.md
+++ b/README.md
@@ -3,13 +3,60 @@ depot
 
 [![Build Status](https://travis-ci.org/tazjin/depot.svg?branch=master)](https://travis-ci.org/tazjin/depot)
 
-This repository is the [monorepo][] for my personal infrastructure. It is built
-using [Nix][] and services are deployed on Google Cloud Platform using
-[Nixery][].
+This repository is the [monorepo][] for my personal tools and infrastructure.
+Everything in here is built using [Nix][] with an automatic attribute-set layout
+that mirrors the filesystem layout of the repository (this might feel familiar
+to users of Bazel).
 
-Everything in here is MIT-licensed unless otherwise indicated in a service
-subfolder.
+This repository used to be hosted on GitHub, but for a variety of reasons I have
+decided to take over the management of personal infrastructure - of which this
+repository is a core component.
+
+If you've ended up here and have no idea who I am, feel free to follow me [on
+Twitter][].
+
+# Highlights
+
+## Tools
+
+* `tools/emacs` contains my personal Emacs configuration (packages & config)
+* `tools/aoc2019` contains solutions for a handful of Advent of Code 2019
+  challenges, before I ran out of interest
+* `tools/blog_cli` contains my tool for writing new blog posts and storing them
+  in the DNS zone
+* `tools/kms_pass.nix` is a tiny tool that emulates the user-interface of
+  `pass`, but actually uses Google Cloud KMS for secret decryption
+
+## Packages / Libraries
+
+* `overrides/buildGo` implements a Nix library that can build Go software in the
+  style of Bazel's `rules_go`. Go programs in this repository are built using
+  this library.
+* `tools/emacs-pkgs` contains various Emacs libraries that my Emacs setup uses
+
+## Services
+
+Services in this repository are deployed on a Google Kubernetes Engine cluster
+using [Nixery]().
+
+* `services/tazblog` contains my blog software (serving at [tazj.in][])
+* `services/cgit-taz` contains a slightly patched version of `cgit` that serves
+  my git web interface at [git.tazj.in][]
+* `services/sync-gcsr` contains a tiny service that synchronises a Google Cloud
+  Source Repository with a local disk path. My `cgit` setup uses this
+  under-the-hood.
+* `services/gemma` contains a no-longer-maintained service that served as an
+  experiment in "household task management" - it's kept in here because I find
+  it interesting
+
+# Contributing
+
+If you'd like to contribute to any of the tools in here, please send a patch
+(using `git format-patch` or `git send-email`) to `reviews@tazj.in`.
 
 [monorepo]: https://en.wikipedia.org/wiki/Monorepo
 [Nix]: https://nixos.org/nix
+[on Twitter]: https://twitter.com/tazjin
 [Nixery]: https://github.com/google/nixery
+[tazj.in]: https://tazj.in
+[git.tazj.in]: https://git.tazj.in