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.

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

Port alleycats README.md from the defunct repo #2222

Merged
merged 1 commit into from
Apr 9, 2018

Conversation

longcao
Copy link
Contributor

@longcao longcao commented Apr 8, 2018

Closes #2202.

This PR ports the useful README.md from the defunct alleycats repo with some very minor changes in wording and also without the buttons and some sections (Getting Alleycats, Copyright and License) since this is now a module within the cats project.

I'm not entirely sure about the licensing thing though, but I did remove the section at the end (see https://github.com/non/alleycats/blob/master/README.md#copyright-and-license) since my reasoning is that the root README.md probably covers things, let me know what works.

Copy link
Contributor

@kailuowang kailuowang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks a lot! It would be nice to have this in the Cats website and linked from the readme line 56 as well. but that can be another PR.

Copy link
Member

@LukaJCB LukaJCB left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Thanks a ton @longcao!

@codecov-io
Copy link

codecov-io commented Apr 9, 2018

Codecov Report

Merging #2222 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #2222   +/-   ##
=======================================
  Coverage   95.05%   95.05%           
=======================================
  Files         333      333           
  Lines        5789     5789           
  Branches      211      211           
=======================================
  Hits         5503     5503           
  Misses        286      286

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 2ae785f...d8f5a4d. Read the comment docs.

@kailuowang kailuowang merged commit 580154e into typelevel:master Apr 9, 2018
@longcao longcao deleted the doc/alleycats-readme branch April 9, 2018 18:35
@kailuowang kailuowang added this to the 1.2 milestone May 30, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants