Skip to content

Commit 8c04f05

Browse files
committed
Standardize readme
1 parent 8ac02b9 commit 8c04f05

1 file changed

Lines changed: 22 additions & 9 deletions

File tree

ReadMe.md

Lines changed: 22 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -9,24 +9,37 @@
99
[![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)
1010

1111
## What is it?
12-
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.
12+
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.
1313

14-
## Why❓
15-
Tierceron hive utilizes trcsh to run as a service that
16-
delivers secrets securely to running [go plugin](https://pkg.go.dev/plugin) implementation of microservices.
14+
## What is in this repo?
15+
- `api`: REST, gRPC, and SOAP client support, endpoint definitions, TLS configuration, retry handling, and example code.
16+
- `core`: plugin event types, chat and command channels, configuration context, data-flow statistics, plugin synchronization, and core configuration helpers.
17+
- `flow`: the flow processing framework for initializing and running Tierceron data pipelines.
18+
- `statsdk`: generated protobuf and gRPC definitions for statistics exchange.
19+
- `trcshfs`: shell-facing filesystem abstractions and `trcshio` helpers.
20+
- `bitlock`, `util`, and `util/mlock`: shared locking and utility helpers.
21+
- `atrium`, `buildopts`, `prod`, and `shell`: build options and runtime support packages used by dependent Tierceron components.
1722

1823
## Key Features
19-
* Configurations delivered in memory from vault to trcsh kernel directly to running tierceron plugin services via an
20-
* Kernel services can be remotely managed via trcsh scripts running in a release pipeline. These scripts require authentication in order to run
24+
- Multi-protocol API caller support for REST, gRPC, and SOAP integrations.
25+
- Shared kernel types for plugin lifecycle, chat exchange, command routing, and data-flow statistics.
26+
- Flow orchestration primitives for building reusable processing pipelines.
27+
- Shared protobuf and filesystem packages used across Tierceron services.
2128

2229

2330
## Getting started
24-
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.
31+
To work on the module locally:
32+
33+
- Run `go test ./...` from the repository root.
34+
- See [api/README.md](api/README.md) for the standalone API caller package documentation.
35+
- See [api/TLS_USAGE.md](api/TLS_USAGE.md) for certificate and TLS configuration details.
36+
- Contributors should start with [GETTING_STARTED.MD](GETTING_STARTED.MD).
2537

2638
## Trusted Committers
2739
- [Joel Rieke](mailto:joel_rieke@trimble.com)
2840
- [David Mkrtychyan](mailto:david_mkrtychyan@trimble.com)
2941
- [Karnveer Gill](mailto:karnveer_gill@trimble.com)
42+
- [Meghan Bailey](mailto:meghan_bailey@trimble.com)
3043

3144
## Contributing
3245
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).
3649
## Code review
3750
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.
3851

39-
## Current effort
40-
Titrating. Tierceron can do a lot of things. Some features are very easy to set up and use, others not so much. Contributions welcomed!
52+
## Security
53+
Please review [SECURITY.md](SECURITY.md) for vulnerability reporting guidance.

0 commit comments

Comments
 (0)