Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README #15

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update README #15

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
7387774
Update README
franciscocpg Mar 23, 2023
5c5e036
Fix title
franciscocpg Mar 23, 2023
3205760
Fix title
franciscocpg Mar 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 5 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,24 +1,20 @@
ReflectME
===========
[![Build Status](https://travis-ci.org/franciscocpg/reflectme.svg?branch=master)](https://travis-ci.org/franciscocpg/reflectme)
[![GoDoc](https://godoc.org/github.com/franciscocpg/reflectme?status.svg)](https://godoc.org/github.com/franciscocpg/reflectme)
![Build Status](https://github.com/franciscocpg/reflectme/actions/workflows/main.yml/badge.svg)
[![Go Reference](https://pkg.go.dev/badge/github.com/franciscocpg/reflectme.svg)](https://pkg.go.dev/github.com/franciscocpg/reflectme)

Package reflectme provides high level abstractions above the golang reflect library with some utilities functions.

The base code is a fork of https://github.com/oleiade/reflections. Then some other concepts and functions were added.


## Installation
Use some dependency manager tool like [glide](https://github.com/Masterminds/glide) pinning to some tag version. Eg
```yaml
package: github.com/franciscocpg/test
import:
- package: github.com/franciscocpg/reflectme
version: 0.1.4
```shell
go get github.com/franciscocpg/reflectme@latest
```

## Usage
As the code is 100% test covered the easier way is to look at [tests](https://github.com/franciscocpg/reflectme/blob/master/reflections_test.go) and [godoc](https://godoc.org/github.com/franciscocpg/reflectme).
Take a look at [tests](https://github.com/franciscocpg/reflectme/blob/master/reflections_test.go) and [go reference](https://pkg.go.dev/github.com/franciscocpg/reflectme).

## Contribute

Expand All @@ -27,4 +23,3 @@ As the code is 100% test covered the easier way is to look at [tests](https://gi
* Write tests which shows that the bug was fixed or that the feature works as expected and make sure the is 100% coverage. One can run `make test-coverage` to see the coverage %. If it's not 100%, one can run `make coverage-missing` to catch the lines that are not covered.
* Send a pull request
* If all checks status are successful the PR is going to be merged.
* Every merged PR is going to tag a new `semver` release