Skip to content

Commit 325f69b

Browse files
committed
Remove some irrelevant portions from the README
1 parent b5c6269 commit 325f69b

File tree

1 file changed

+6
-62
lines changed

1 file changed

+6
-62
lines changed

README.md

Lines changed: 6 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,24 @@
11
<div align="center">
22
<h1>hvr-scripts 🛠📦</h1>
33

4-
<p>CLI toolbox for common scripts for my projects</p>
4+
<p>CLI toolbox for common scripts for <del>my</del> <strong>our</strong> projects</p>
55
</div>
66

77
<hr />
88

99
[![Build Status][build-badge]][build]
1010
[![Code Coverage][coverage-badge]][coverage]
1111
[![version][version-badge]][package]
12-
[![downloads][downloads-badge]][npmcharts]
1312
[![MIT License][license-badge]][license]
1413

15-
[![All Contributors](https://img.shields.io/badge/all_contributors-12-orange.svg?style=flat-square)](#contributors)
16-
[![PRs Welcome][prs-badge]][prs]
17-
[![Code of Conduct][coc-badge]][coc]
18-
19-
[![Watch on GitHub][github-watch-badge]][github-watch]
20-
[![Star on GitHub][github-star-badge]][github-star]
21-
[![Tweet][twitter-badge]][twitter]
22-
2314
## The problem
2415

25-
I do a bunch of open source and want to make it easier to maintain so many
16+
~~I~~ **We** do a bunch of open source and want to make it easier to maintain so many
2617
projects.
2718

2819
## This solution
2920

30-
This is a CLI that abstracts away all configuration for my open source projects
21+
This is a CLI that abstracts away all configuration for ~~my~~ **our** open source projects
3122
for linting, testing, building, and more.
3223

3324
## Table of Contents
@@ -38,10 +29,6 @@ for linting, testing, building, and more.
3829
- [Installation](#installation)
3930
- [Usage](#usage)
4031
- [Overriding Config](#overriding-config)
41-
- [Flow support](#flow-support)
42-
- [Inspiration](#inspiration)
43-
- [Other Solutions](#other-solutions)
44-
- [Contributors](#contributors)
4532
- [LICENSE](#license)
4633

4734
<!-- END doctoc generated TOC please keep comment here to allow auto update -->
@@ -52,14 +39,12 @@ This module is distributed via [npm][npm] which is bundled with [node][node] and
5239
should be installed as one of your project's `devDependencies`:
5340

5441
```
55-
npm install --save-dev hvr-scripts
42+
yarn add -D hvr-scripts
5643
```
5744

5845
## Usage
5946

60-
This is a CLI and exposes a bin called `hvr-scripts`. I don't really plan on
61-
documenting or testing it super duper well because it's really specific to my
62-
needs. You'll find all available scripts in `src/scripts`.
47+
This is a CLI and exposes a bin called `hvr-scripts`. You'll find all available scripts in `src/scripts`.
6348

6449
This project actually dogfoods itself. If you look in the `package.json`, you'll
6550
find scripts with `node src {scriptName}`. This serves as an example of some
@@ -85,9 +70,6 @@ contents of:
8570
{"extends": "./node_modules/hvr-scripts/eslint.js"}
8671
```
8772

88-
> Note: for now, you'll have to include an `.eslintignore` in your project until
89-
> [this eslint issue is resolved](https://github.com/eslint/eslint/issues/9227).
90-
9173
Or, for `babel`, a `.babelrc` with:
9274

9375
```
@@ -110,30 +92,7 @@ module.exports = Object.assign(jestConfig, {
11092

11193
> Note: `hvr-scripts` intentionally does not merge things for you when you start
11294
> configuring things to make it less magical and more straightforward. Extending
113-
> can take place on your terms. I think this is actually a great way to do this.
114-
115-
### Flow support
116-
117-
If the `flow-bin` is a dependency on the project the `@babel/preset-flow` will automatically get loaded when you use the default babel config that comes with `hvr-scripts`. If you customised your `.babelrc`-file you might need to manually add `@babel/preset-flow` to the `presets`-section.
118-
119-
## Inspiration
120-
121-
This is inspired by `react-scripts`.
122-
123-
## Other Solutions
124-
125-
I'm not aware of any, if you are please [make a pull request][prs] and add it
126-
here! Again, this is a very specific-to-me solution.
127-
128-
## Contributors
129-
130-
Thanks goes to these people ([emoji key][emojis]):
131-
132-
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
133-
<!-- prettier-ignore -->
134-
<table><tr><td align="center"><a href="https://kentcdodds.com"><img src="https://avatars.githubusercontent.com/u/1500684?v=3" width="100px;" alt="Kent C. Dodds"/><br /><sub><b>Kent C. Dodds</b></sub></a><br /><a href="https://github.com/kentcdodds/hvr-scripts/commits?author=kentcdodds" title="Code">💻</a> <a href="https://github.com/kentcdodds/kcd-scripts/commits?author=kentcdodds" title="Documentation">📖</a> <a href="#infra-kentcdodds" title="Infrastructure (Hosting, Build-Tools, etc)">🚇</a> <a href="https://github.com/kentcdodds/kcd-scripts/commits?author=kentcdodds" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/sudo-suhas"><img src="https://avatars2.githubusercontent.com/u/22251956?v=4" width="100px;" alt="Suhas Karanth"/><br /><sub><b>Suhas Karanth</b></sub></a><br /><a href="https://github.com/kentcdodds/kcd-scripts/commits?author=sudo-suhas" title="Code">💻</a> <a href="https://github.com/kentcdodds/kcd-scripts/issues?q=author%3Asudo-suhas" title="Bug reports">🐛</a> <a href="https://github.com/kentcdodds/kcd-scripts/commits?author=sudo-suhas" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/pbomb"><img src="https://avatars0.githubusercontent.com/u/1402095?v=4" width="100px;" alt="Matt Parrish"/><br /><sub><b>Matt Parrish</b></sub></a><br /><a href="https://github.com/kentcdodds/kcd-scripts/commits?author=pbomb" title="Code">💻</a> <a href="https://github.com/kentcdodds/kcd-scripts/commits?author=pbomb" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/mateuscb"><img src="https://avatars3.githubusercontent.com/u/1319157?v=4" width="100px;" alt="Mateus"/><br /><sub><b>Mateus</b></sub></a><br /><a href="https://github.com/kentcdodds/kcd-scripts/commits?author=mateuscb" title="Code">💻</a> <a href="https://github.com/kentcdodds/kcd-scripts/commits?author=mateuscb" title="Tests">⚠️</a></td><td align="center"><a href="http://macklin.underdown.me"><img src="https://avatars1.githubusercontent.com/u/2344137?v=4" width="100px;" alt="Macklin Underdown"/><br /><sub><b>Macklin Underdown</b></sub></a><br /><a href="https://github.com/kentcdodds/kcd-scripts/commits?author=macklinu" title="Code">💻</a> <a href="https://github.com/kentcdodds/kcd-scripts/commits?author=macklinu" title="Tests">⚠️</a></td><td align="center"><a href="https://github.com/stereobooster"><img src="https://avatars2.githubusercontent.com/u/179534?v=4" width="100px;" alt="stereobooster"/><br /><sub><b>stereobooster</b></sub></a><br /><a href="https://github.com/kentcdodds/kcd-scripts/commits?author=stereobooster" title="Code">💻</a> <a href="https://github.com/kentcdodds/kcd-scripts/commits?author=stereobooster" title="Tests">⚠️</a></td><td align="center"><a href="http://dsds.io"><img src="https://avatars0.githubusercontent.com/u/410792?v=4" width="100px;" alt="Dony Sukardi"/><br /><sub><b>Dony Sukardi</b></sub></a><br /><a href="https://github.com/kentcdodds/kcd-scripts/issues?q=author%3Adonysukardi" title="Bug reports">🐛</a> <a href="https://github.com/kentcdodds/kcd-scripts/commits?author=donysukardi" title="Code">💻</a></td></tr><tr><td align="center"><a href="https://alexandernanberg.com"><img src="https://avatars3.githubusercontent.com/u/8997319?v=4" width="100px;" alt="Alexander Nanberg"/><br /><sub><b>Alexander Nanberg</b></sub></a><br /><a href="https://github.com/kentcdodds/kcd-scripts/commits?author=alexandernanberg" title="Code">💻</a></td><td align="center"><a href="https://github.com/fobbyal"><img src="https://avatars2.githubusercontent.com/u/7818365?v=4" width="100px;" alt="Alex Liang"/><br /><sub><b>Alex Liang</b></sub></a><br /><a href="https://github.com/kentcdodds/kcd-scripts/commits?author=fobbyal" title="Code">💻</a></td><td align="center"><a href="http://www.jeffdetmer.com"><img src="https://avatars1.githubusercontent.com/u/649578?v=4" width="100px;" alt="Jeff Detmer"/><br /><sub><b>Jeff Detmer</b></sub></a><br /><a href="https://github.com/kentcdodds/kcd-scripts/commits?author=shellthor" title="Code">💻</a></td><td align="center"><a href="https://twitter.com/endymion_r"><img src="https://avatars3.githubusercontent.com/u/93752?v=4" width="100px;" alt="Alex Zherdev"/><br /><sub><b>Alex Zherdev</b></sub></a><br /><a href="https://github.com/kentcdodds/kcd-scripts/commits?author=alexzherdev" title="Code">💻</a></td><td align="center"><a href="https://github.com/adamdharrington"><img src="https://avatars0.githubusercontent.com/u/5477801?v=4" width="100px;" alt="Adam Harrington"/><br /><sub><b>Adam Harrington</b></sub></a><br /><a href="https://github.com/kentcdodds/kcd-scripts/commits?author=adamdharrington" title="Code">💻</a> <a href="https://github.com/kentcdodds/kcd-scripts/commits?author=adamdharrington" title="Tests">⚠️</a></td></tr></table>
135-
136-
<!-- ALL-CONTRIBUTORS-LIST:END -->
95+
> can take place on your terms. ~~I~~ _Kent_ thinks this is actually a great way to do this.
13796
13897
This project follows the [all-contributors][all-contributors] specification.
13998
Contributions of any kind welcome!
@@ -150,20 +109,5 @@ MIT
150109
[coverage]: https://codecov.io/github/kentcdodds/hvr-scripts
151110
[version-badge]: https://img.shields.io/npm/v/hvr-scripts.svg?style=flat-square
152111
[package]: https://www.npmjs.com/package/hvr-scripts
153-
[downloads-badge]: https://img.shields.io/npm/dm/hvr-scripts.svg?style=flat-square
154-
[npmcharts]: http://npmcharts.com/compare/hvr-scripts
155112
[license-badge]: https://img.shields.io/npm/l/hvr-scripts.svg?style=flat-square
156113
[license]: https://github.com/kentcdodds/hvr-scripts/blob/master/LICENSE
157-
[prs-badge]: https://img.shields.io/badge/PRs-welcome-brightgreen.svg?style=flat-square
158-
[prs]: http://makeapullrequest.com
159-
[donate-badge]: https://img.shields.io/badge/$-support-green.svg?style=flat-square
160-
[coc-badge]: https://img.shields.io/badge/code%20of-conduct-ff69b4.svg?style=flat-square
161-
[coc]: https://github.com/kentcdodds/hvr-scripts/blob/master/other/CODE_OF_CONDUCT.md
162-
[github-watch-badge]: https://img.shields.io/github/watchers/kentcdodds/hvr-scripts.svg?style=social
163-
[github-watch]: https://github.com/kentcdodds/hvr-scripts/watchers
164-
[github-star-badge]: https://img.shields.io/github/stars/kentcdodds/hvr-scripts.svg?style=social
165-
[github-star]: https://github.com/kentcdodds/hvr-scripts/stargazers
166-
[twitter]: https://twitter.com/intent/tweet?text=Check%20out%20hvr-scripts!%20https://github.com/kentcdodds/kcd-scripts%20%F0%9F%91%8D
167-
[twitter-badge]: https://img.shields.io/twitter/url/https/github.com/kentcdodds/hvr-scripts.svg?style=social
168-
[emojis]: https://github.com/kentcdodds/all-contributors#emoji-key
169-
[all-contributors]: https://github.com/kentcdodds/all-contributors

0 commit comments

Comments
 (0)