Skip to content

Commit

Permalink
chore(release): version bump v1.0.3
Browse files Browse the repository at this point in the history
  • Loading branch information
preshonyee committed Apr 25, 2021
1 parent 656a629 commit bf2acdd
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 16 deletions.
25 changes: 10 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<div style="text-align: center; background-color: #eee">
<img src="https://emojipedia-us.s3.dualstack.us-west-1.amazonaws.com/thumbs/120/apple/271/man-astronaut-dark-skin-tone_1f468-1f3ff-200d-1f680.png" alt="component scaffolder logo" >
</div>

# Component Scaffolder

[![NPM](https://img.shields.io/npm/v/component-scaffolder.svg)](https://www.npmjs.com/package/component-scaffolder) [![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
Expand All @@ -6,36 +10,27 @@ This is a NodeJS CLI helps you quickly generate your React components either as

## Usage

Recommended

```bash
npx component-scaffolder
```

Alternatives

```bash
npm install --dev component-scaffolder

# or

yarn add --dev component-scaffolder
```

For component scaffolder to work properly, it assumes that you have a `src` folder and `components` folder in your current working directory.

Follow the prompt that appears and select the type of files you want your components to be in (either JavaScript/TypeScript), and input the name of your component

## What's included?

Component scaffolder includes support for styling with SASS, TypeScript types, tests, and Storybook.
Component scaffolder includes support for styling with Styled Component, TypeScript types, tests, and Storybook.

- Component.js/ts
- Component.scss (for styling)
- Component.styles.js/ts (for styling with Styled Components)
- Component.types.js/ts (for typescript types)
- Component.test.jsx/tsx (test files)
- Component.stories.js/ts (storybookJS files)
- index.js/ts

## Libraries using Component Scaffolder

- [Camara Design System](https://github.com/Camaradotspace/camara-react)

## License

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "component-scaffolder",
"version": "1.0.2",
"version": "1.0.3",
"description": "Opinionated NodeJS CLI for generating React components",
"main": "src/index.js",
"bin": "src/index.js",
Expand Down

0 comments on commit bf2acdd

Please sign in to comment.