Skip to content

Commit

Permalink
Add README.md with project information and instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jasonrundell committed Oct 22, 2024
1 parent 2d7e39a commit a6dfbce
Showing 1 changed file with 63 additions and 0 deletions.
63 changes: 63 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,63 @@
# Dropship

## Introduction
Dropship is a component library designed to provide reusable UI components for your projects. It includes a variety of atoms, molecules, and organisms to help you build consistent and maintainable user interfaces.

## Installation
To install the project dependencies, run:

```sh
npm install
```

## Usage

To start the development server and view the components in Storybook, run:

```sh
npm run storybook
```

## Atoms

Atoms are the basic building blocks of a user interface. They include elements like buttons, inputs, and links. Here are all of the atoms included in Dropship:

- Article
- Avatar
- Blockquote
- Box
- Button
- Cite
- Container
- Footer
- Grid
- Heading
- Icon
- Link
- Main
- Paragraph
- Row
- Section
- Spacer
- Strong

## Storybook

This project uses Storybook for developing and showcasing components. You can find stories for various components in the src/stories directory.

## Scripts

Here are some useful scripts you can run:

- `npm run build`: Builds the project.
- `npm run start`: Starts the development server.
- `npm run test`: Runs the tests.
- `npm run storybook`: Starts the Storybook server.

## Contributing

If you would like to contribute, please follow the contributing guidelines.

## License

This project is licensed under the MIT License. See the LICENSE file for details.

0 comments on commit a6dfbce

Please sign in to comment.