Update README (#12)

README.md

@@ -1,38 +1,40 @@
-# akita-ir
-
-Intermediate Representation for APIs
+# Intermediate representation for APIs
 
 ## Contents
 
-This repo contains protobuf definitions and generator scripts for Go, Python and Javascript.
+This repository supports the [Postman Insights
+Agent](https://github.com/postmanlabs/postman-insights-agent). It contains
+protobuf definitions and generator scripts for Go, Python, and JavaScript.
 
-We check the generated code into source control so we can use native language
-tooling without having to worry about invoking the protoc compiler.
+Generated code is checked into source control to enable the use of
+native-language tooling without needing to invoke the `protoc` compiler.
 
-## Updating Protobuf Definition
+## Updating the Protobuf definition
 
 - Make the change under `proto/`
 - Run `make build`
-- Update `akita-libs` with the new version of the Go package
-- In `akita-libs/spec_utils/ir_hash`, update `gen.go` with any new message
-  types, or new inner structs from oneof types. Then run `make` in that
-  directory to generate a new set of hash functions. (If you add a new
+- Update
+  [`observability-shared-libs`](https://github.com/postmanlabs/observability-shared-libs)
+  with the new version of the Go package
+- In `observability-shared-libs/spec_utils/ir_hash`, update `gen.go` with any
+  new message types, or new inner structs from oneof types. Then run `make` in
+  that directory to generate a new set of hash functions. (If you add a new
   file, add that file to the list in `gen.go` so that it will be checked
   for version mismatch.)
 
-## Directory Structure
+## Directory structure
 
 ```
 proto/  # protobuf definitions
   foo/  # protobuf package
   ...
 
-go/     # Generated go code
+go/     # Generated Go code
   foo/
 
-py/     # Generated python code
+py/     # Generated Python code
   foo/
 
-js/     # Generated javascript code
+js/     # Generated JavaScript code
   foo/
 ```