Skip to content

Commit

Permalink
Updated README to reflect status
Browse files Browse the repository at this point in the history
  • Loading branch information
Mike Schinkel committed Oct 21, 2022
1 parent 051eff5 commit 2eaf958
Showing 1 changed file with 14 additions and 3 deletions.
17 changes: 14 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,23 @@
# glice
# glice — v3 (Hopefully)

<!--
[![Build Status](https://img.shields.io/github/workflow/status/ribice/glice/CI?style=flat-square)](https://github.com/ribice/glice/actions?query=workflow%3ACI)
[![Coverage Status](https://coveralls.io/repos/github/ribice/glice/badge.svg?branch=master)](https://coveralls.io/github/ribice/glice?branch=master)
[![Go Report Card](https://goreportcard.com/badge/github.com/ribice/glice)](https://goreportcard.com/report/github.com/ribice/glice)

-->
Golang license and dependency checker. Prints list of all dependencies, their URL, license and saves all the license files in /licenses.

## Release TODO
## Status/Intention

This code is in a sort of no-man's land state.

Is has been updated from the fork to a level sufficient to meet the needs of a client. The client wants to submit the changes back to the original project ([Glice](https://github.com/ribice/glice)) so that they do not need to maintain for their needs, but they have also asked me to only update to the level of meet their needs, at least for the time being, because they have other things for me to work on that they consider more urgent.

OTOH it if a major breaking change to the forked code so the original developer may have zero interest in merging it. But even if they do want to merge the code the README does not yet reflect the changes made nor is the functionality fixed yet that was broken during refactoring, all per the client's limits on my time _(and I have had no free time to do on my own given the time required for the client's projects.)_

Feel free to use at your own risk. Also, feel free to submit issues if you have questions you think could be quickly answered and/or if you would like to discuss submitting a PR to this fork at this repo.

## TODO Needed before PR (IMO)
- Rewrite the README.md to document v3
- Implement Caching and TTL support
- Update `.goReleaser.yaml` and ensure it can produce a viable release.
Expand Down

0 comments on commit 2eaf958

Please sign in to comment.