Skip to content

Commit

Permalink
chore: updated README
Browse files Browse the repository at this point in the history
  • Loading branch information
johnabass committed Dec 26, 2024
1 parent 11c9b35 commit e90e9e6
Showing 1 changed file with 6 additions and 16 deletions.
22 changes: 6 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# medley

medley does something good.
medley provides service location based on hashing.

[![Build Status](https://github.com/xmidt-org/medley/actions/workflows/ci.yml/badge.svg)](https://github.com/xmidt-org/medley/actions/workflows/ci.yml)
[![codecov.io](http://codecov.io/github/xmidt-org/medley/coverage.svg?branch=main)](http://codecov.io/github/xmidt-org/medley?branch=main)
Expand All @@ -10,27 +10,13 @@ medley does something good.
[![GitHub Release](https://img.shields.io/github/release/xmidt-org/medley.svg)](CHANGELOG.md)
[![GoDoc](https://pkg.go.dev/badge/github.com/xmidt-org/medley)](https://pkg.go.dev/github.com/xmidt-org/medley)

## Setup

1. Search and replace medley with your project name.
1. Initialize `go.mod` file: `go mod init github.com/xmidt-org/medley`
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`, `medley.yaml`, `deploy/`, and `conf/`.


## Summary

Medley is a consistent hash package that also exposes a simple API for creating additional hash strategies.
Medley is a Service Locator package that finds services based on hashing some arbitrary object. Currently, only consistent hashing is supported.

## Table of Contents

- [Code of Conduct](#code-of-conduct)
- [Details](#details)
- [Install](#install)
- [Contributing](#contributing)

Expand All @@ -39,6 +25,10 @@ Medley is a consistent hash package that also exposes a simple API for creating
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.

## Install

go get -u github.com/xmidt-org/medley

## Contributing

Refer to [CONTRIBUTING.md](CONTRIBUTING.md).

0 comments on commit e90e9e6

Please sign in to comment.