Merge pull request #107 from trimble-oss/readme_standardize

Standardize readme

Author: joel-rieke

ReadMe.md

@@ -9,24 +9,37 @@
 [![PkgGoDev](https://img.shields.io/badge/go.dev-docs-007d9c?logo=go&logoColor=white&style=flat-square)](https://pkg.go.dev/github.com/trimble-oss/tierceron-core)
 
 ## What is it?
-Tierceron-core is an interface definition project in support of the tierceron hive.  It provides a list of supported events emitted by the hive kernel.
+Tierceron-core is the shared Go module for Tierceron runtime, transport, and flow plumbing. It packages the reusable APIs, plugin coordination types, filesystem abstractions, statistics protobufs, and utility layers that higher-level Tierceron services import.
 
-## Why❓
-Tierceron hive utilizes trcsh to run as a service that
-delivers secrets securely to running [go plugin](https://pkg.go.dev/plugin) implementation of microservices.
+## What is in this repo?
+- `api`: REST, gRPC, and SOAP client support, endpoint definitions, TLS configuration, retry handling, and example code.
+- `core`: plugin event types, chat and command channels, configuration context, data-flow statistics, plugin synchronization, and core configuration helpers.
+- `flow`: the flow processing framework for initializing and running Tierceron data pipelines.
+- `statsdk`: generated protobuf and gRPC definitions for statistics exchange.
+- `trcshfs`: shell-facing filesystem abstractions and `trcshio` helpers.
+- `bitlock`, `util`, and `util/mlock`: shared locking and utility helpers.
+- `atrium`, `buildopts`, `prod`, and `shell`: build options and runtime support packages used by dependent Tierceron components.
 
 ## Key Features
-* Configurations delivered in memory from vault to trcsh kernel directly to running tierceron plugin services via an 
-* Kernel services can be remotely managed via trcsh scripts running in a release pipeline.  These scripts require authentication in order to run
+- Multi-protocol API caller support for REST, gRPC, and SOAP integrations.
+- Shared kernel types for plugin lifecycle, chat exchange, command routing, and data-flow statistics.
+- Flow orchestration primitives for building reusable processing pipelines.
+- Shared protobuf and filesystem packages used across Tierceron services.
 
 
 ## Getting started
-If you are a contributor, please have a look on the [getting started](GETTING_STARTED.MD) file. Here you can check the information required and other things before providing a useful contribution.
+To work on the module locally:
+
+- Run `go test ./...` from the repository root.
+- See [api/README.md](api/README.md) for the standalone API caller package documentation.
+- See [api/TLS_USAGE.md](api/TLS_USAGE.md) for certificate and TLS configuration details.
+- Contributors should start with [GETTING_STARTED.MD](GETTING_STARTED.MD).
 
 ## Trusted Committers
 - [Joel Rieke](mailto:joel_rieke@trimble.com)
 - [David Mkrtychyan](mailto:david_mkrtychyan@trimble.com)
 - [Karnveer Gill](mailto:karnveer_gill@trimble.com)
+- [Meghan Bailey](mailto:meghan_bailey@trimble.com)
 
 ## Contributing
 Contributions are always welcome, no matter how large or small. Before contributing, please read the [code of conduct](CODE_OF_CONDUCT.MD).
@@ -36,5 +49,5 @@ See [Contributing](CONTRIBUTING.MD).
 ## Code review
 Check the [code review](CODE_REVIEW.MD) information to find out how a **Pull Request** is evaluated for this project and what other coding standards you should consider when you want to contribute.
 
-## Current effort
-Titrating.  Tierceron can do a lot of things.  Some features are very easy to set up and use, others not so much.  Contributions welcomed!
+## Security
+Please review [SECURITY.md](SECURITY.md) for vulnerability reporting guidance.