initial setup

CHANGELOG.md

@@ -8,6 +8,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [v0.0.1]
 - Initial creation
+- external configuration
+- bootstrapping for the core prometheus objects:  Registerer and Gatherer
+- bootstrapping for the HTTP environment
+- bundled HTTP metrics
 
-[Unreleased]: https://github.com/xmidt-org/__PROJECT__/compare/v0.0.1..HEAD
-[v0.0.1]: https://github.com/xmidt-org/__PROJECT__/compare/0.0.0...v0.0.1
+[Unreleased]: https://github.com/xmidt-org/touchstone/compare/v0.0.1..HEAD
+[v0.0.1]: https://github.com/xmidt-org/touchstone/compare/0.0.0...v0.0.1

NOTICE

@@ -1,4 +1,4 @@
-__PROJECT__
+touchstone
 Copyright 2020 Comcast Cable Communications Management, LLC
 
 Licensed under the Apache License, Version 2.0 (the "License");

README.md

@@ -1,38 +1,22 @@
-# __PROJECT__
+# touchstone
 
-__PROJECT__ does something good.
+Touchstone is an integration between go.uber.org/fx and prometheus.
 
-[![Build Status](https://travis-ci.com/xmidt-org/__PROJECT__.svg?branch=main)](https://travis-ci.com/xmidt-org/__PROJECT__)
-[![codecov.io](http://codecov.io/github/xmidt-org/__PROJECT__/coverage.svg?branch=main)](http://codecov.io/github/xmidt-org/__PROJECT__?branch=main)
-[![Go Report Card](https://goreportcard.com/badge/github.com/xmidt-org/__PROJECT__)](https://goreportcard.com/report/github.com/xmidt-org/__PROJECT__)
-[![Apache V2 License](http://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/xmidt-org/__PROJECT__/blob/main/LICENSE)
+[![Build Status](https://travis-ci.com/xmidt-org/touchstone.svg?branch=main)](https://travis-ci.com/xmidt-org/touchstone)
+[![codecov.io](http://codecov.io/github/xmidt-org/touchstone/coverage.svg?branch=main)](http://codecov.io/github/xmidt-org/touchstone?branch=main)
+[![Go Report Card](https://goreportcard.com/badge/github.com/xmidt-org/touchstone)](https://goreportcard.com/report/github.com/xmidt-org/touchstone)
+[![Apache V2 License](http://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://github.com/xmidt-org/touchstone/blob/main/LICENSE)
 [![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=xmidt-org_PROJECT&metric=alert_status)](https://sonarcloud.io/dashboard?id=xmidt-org_PROJECT)
-[![GitHub release](https://img.shields.io/github/release/xmidt-org/__PROJECT__.svg)](CHANGELOG.md)
-[![PkgGoDev](https://pkg.go.dev/badge/github.com/xmidt-org/__PROJECT__)](https://pkg.go.dev/github.com/xmidt-org/__PROJECT__)
-
-## Setup
-
-1. Search and replace __PROJECT__ with your project name.
-1. Initialize `go.mod` file: `go mod init github.com/xmidt-org/__PROJECT__`
-1. Add org teams to project (Settings > Manage Access): 
-    - xmidt-org/admins with Admin role
-    - xmidt-org/server-writers with Write role
-1. Manually create the first release.  After v0.0.1 exists, other releases will be made by automation after the CHANGELOG is updated to reflect a new version header and nothing under the Unreleased header.
-1. For libraries:
-    1. Add org workflows in dir `.github/workflows`: push, tag, and release. This can be done by going to the Actions tab for the repo on the github site.
-    1. Remove the following files/dirs: `.dockerignore`, `Dockerfile`, `Makefile`, `rpkg.macros`, `__PROJECT__.yaml`, `deploy/`, and `conf/`.
-1. For applications:
-    1. Remove PkgGoDev badge from this file.
-    1. Add org workflows in dir `.github/workflows`: push, tag, release, and docker-release. This can be done by going to the Actions tab for the repo on the github site.
-    1. Add project name, `.ignore`, and `errors.txt` to `.gitignore` file.
-    1. Update `Dockerfile` - choose new ports to expose that no current XMiDT application is using.
-    1. Update `deploy/packaging/__PROJECT__.spec` file to have a proper Summary and Description.
-    1. Update `conf/__PROJECT__.service` file to have a proper Description.
-
+[![GitHub release](https://img.shields.io/github/release/xmidt-org/touchstone.svg)](CHANGELOG.md)
+[![PkgGoDev](https://pkg.go.dev/badge/github.com/xmidt-org/touchstone)](https://pkg.go.dev/github.com/xmidt-org/touchstone)
 
 ## Summary
 
-Summary should be a small paragraph explanation of what this project does.
+Touchstone provides easy bootstrapping of a prometheus client environment within a go.uber.org/fx application container.  Key features include:
+
+- External configuration that can drive how the Registry and other components are initialized
+- Simple constructors that allow individual metrics to fully participate in dependency injection
+- Prebundled HTTP metrics with a simpler and more efficient instrumentation than what promhttp provides
 
 ## Table of Contents
 
@@ -46,13 +30,9 @@ Summary should be a small paragraph explanation of what this project does.
 This project and everyone participating in it are governed by the [XMiDT Code Of Conduct](https://xmidt.io/code_of_conduct/). 
 By participating, you agree to this Code.
 
-## Details
-
-Add details here.
-
 ## Install
 
-Add details here.
+go get -u github.com/xmidt-org/touchstone
 
 ## Contributing