diff --git a/README.md b/README.md index 57a5e0c2..8a121a4d 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # Shepherd -Illustration of a sheep +Illustration of a sheep [![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/NerdWalletOSS/shepherd/release.yml?style=flat-square)](https://github.com/NerdWalletOSS/shepherd/actions) [![semantic-release: conventionalcommits](https://img.shields.io/badge/semantic--release-conventionalcommits-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release) @@ -156,3 +156,7 @@ cd ../my-other-project Shepherd currently has minimal test coverage, but we're aiming to improve that with each new PR. Tests are written with Jest and should be named in a `*.test.ts` alongside the file under test. To run the test suite, run `yarn test`. We use [ESLint](https://eslint.org/) to ensure a consistent coding style and to help prevent certain classes of problems. Run `yarn lint` to run the linter, and `yarn fix-lint` to automatically fix applicable problems. + +### Credits + +1. Logo designed by Christopher Wharton. diff --git a/images/shepherd-logo.png b/images/shepherd-logo.png new file mode 100644 index 00000000..9065d2b7 Binary files /dev/null and b/images/shepherd-logo.png differ