Skip to content

Commit

Permalink
chore: sync README across packages
Browse files Browse the repository at this point in the history
  • Loading branch information
danielroe committed Jun 9, 2020
1 parent efde44b commit dc6a046
Show file tree
Hide file tree
Showing 4 changed files with 166 additions and 0 deletions.
49 changes: 49 additions & 0 deletions packages/cli/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<h1 align="center">🌬️ Siroc</h1>
<p align="center">Zero-config build tooling for Node</p>

<p align="center">
<a href="https://npmjs.com/package/siroc">
<img alt="" src="https://img.shields.io/npm/v/siroc/latest.svg?style=flat-square">
</a>
<a href="https://bundlephobia.com/result?p=siroc">
<img alt="" src="https://img.shields.io/bundlephobia/minzip/siroc?style=flat-square">
</a>
<a href="https://npmjs.com/package/siroc">
<img alt="" src="https://img.shields.io/npm/dt/siroc.svg?style=flat-square">
</a>
<a href="https://lgtm.com/projects/g/nuxt-contrib/siroc">
<img alt="" src="https://img.shields.io/lgtm/alerts/github/nuxt-contrib/siroc?style=flat-square">
</a>
<a href="https://lgtm.com/projects/g/nuxt-contrib/siroc">
<img alt="" src="https://img.shields.io/lgtm/grade/javascript/github/nuxt-contrib/siroc?style=flat-square">
</a>
<a href="https://david-dm.org/nuxt-contrib/siroc">
<img alt="" src="https://img.shields.io/david/nuxt-contrib/siroc.svg?style=flat-square">
</a>
</p>

## Contributors

Contributions are very welcome.

1. Clone this repo

```bash
git clone git@github.com:nuxt-contrib/siroc.git
```

2. Install dependencies and build project

```bash
yarn
# Compile library and watch for changes
yarn watch
# Test (on changes)
yarn test
```

**Tip:** You can also run `yarn link` within a package directory to test the module locally with another project.

## License

[MIT License](./LICENCE) - Made with 💖
49 changes: 49 additions & 0 deletions packages/core/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<h1 align="center">🌬️ Siroc</h1>
<p align="center">Zero-config build tooling for Node</p>

<p align="center">
<a href="https://npmjs.com/package/siroc">
<img alt="" src="https://img.shields.io/npm/v/siroc/latest.svg?style=flat-square">
</a>
<a href="https://bundlephobia.com/result?p=siroc">
<img alt="" src="https://img.shields.io/bundlephobia/minzip/siroc?style=flat-square">
</a>
<a href="https://npmjs.com/package/siroc">
<img alt="" src="https://img.shields.io/npm/dt/siroc.svg?style=flat-square">
</a>
<a href="https://lgtm.com/projects/g/nuxt-contrib/siroc">
<img alt="" src="https://img.shields.io/lgtm/alerts/github/nuxt-contrib/siroc?style=flat-square">
</a>
<a href="https://lgtm.com/projects/g/nuxt-contrib/siroc">
<img alt="" src="https://img.shields.io/lgtm/grade/javascript/github/nuxt-contrib/siroc?style=flat-square">
</a>
<a href="https://david-dm.org/nuxt-contrib/siroc">
<img alt="" src="https://img.shields.io/david/nuxt-contrib/siroc.svg?style=flat-square">
</a>
</p>

## Contributors

Contributions are very welcome.

1. Clone this repo

```bash
git clone git@github.com:nuxt-contrib/siroc.git
```

2. Install dependencies and build project

```bash
yarn
# Compile library and watch for changes
yarn watch
# Test (on changes)
yarn test
```

**Tip:** You can also run `yarn link` within a package directory to test the module locally with another project.

## License

[MIT License](./LICENCE) - Made with 💖
49 changes: 49 additions & 0 deletions packages/siroc/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
<h1 align="center">🌬️ Siroc</h1>
<p align="center">Zero-config build tooling for Node</p>

<p align="center">
<a href="https://npmjs.com/package/siroc">
<img alt="" src="https://img.shields.io/npm/v/siroc/latest.svg?style=flat-square">
</a>
<a href="https://bundlephobia.com/result?p=siroc">
<img alt="" src="https://img.shields.io/bundlephobia/minzip/siroc?style=flat-square">
</a>
<a href="https://npmjs.com/package/siroc">
<img alt="" src="https://img.shields.io/npm/dt/siroc.svg?style=flat-square">
</a>
<a href="https://lgtm.com/projects/g/nuxt-contrib/siroc">
<img alt="" src="https://img.shields.io/lgtm/alerts/github/nuxt-contrib/siroc?style=flat-square">
</a>
<a href="https://lgtm.com/projects/g/nuxt-contrib/siroc">
<img alt="" src="https://img.shields.io/lgtm/grade/javascript/github/nuxt-contrib/siroc?style=flat-square">
</a>
<a href="https://david-dm.org/nuxt-contrib/siroc">
<img alt="" src="https://img.shields.io/david/nuxt-contrib/siroc.svg?style=flat-square">
</a>
</p>

## Contributors

Contributions are very welcome.

1. Clone this repo

```bash
git clone git@github.com:nuxt-contrib/siroc.git
```

2. Install dependencies and build project

```bash
yarn
# Compile library and watch for changes
yarn watch
# Test (on changes)
yarn test
```

**Tip:** You can also run `yarn link` within a package directory to test the module locally with another project.

## License

[MIT License](./LICENCE) - Made with 💖
19 changes: 19 additions & 0 deletions siroc.config.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
// @ts-check

import { copy } from 'fs-extra'
import { resolve } from 'path'

/**
* @type {import('@siroc/core').PackageOptions} config
*/
const config = {
hooks: {
'build:done'(pkg) {
const readme = resolve(__dirname, 'README.md')
const destination = resolve(pkg.options.rootDir, 'README.md')

copy(readme, destination)
},
},
}
export default config

0 comments on commit dc6a046

Please sign in to comment.