Skip to content

Commit fe81769

Browse files
committed
docs(docs): added various repo documentation files
Added content to readme, Contributing, license and added the logo
1 parent 8decd17 commit fe81769

File tree

4 files changed

+87
-2
lines changed

4 files changed

+87
-2
lines changed

.github/assets/dotsui-logo.png

9.04 KB
Loading

CONTRIBUTING.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributing
2+
3+
This project is open source and contributions are welcome! The guidelines aren't fully written yet, but in general, you can follow the steps below to contribute:
4+
5+
1. Fork the repository
6+
2. Clone the repository
7+
3. Run `yarn install` to install dependencies (we use [Yarn](https://yarnpkg.com/), please don't use NPM since it will cause issues with the lockfile)
8+
4. Make your changes
9+
5. Run `yarn build` to build the project
10+
6. Run `yarn test` to run tests (eventually we will have tests)
11+
7. Make sure everything works
12+
8. Commit your changes
13+
9. Push your changes
14+
10. Open a pull request
15+
11. Wait for a maintainer to review your pull request - get a cookie or something while you wait. You deserve it 👾.
16+
17+
## Notes
18+
19+
- We use [commitizen](https://github.com/commitizen/cz-cli) to format commit messages. Please use `yarn commit` to commit your changes (or if you have commitizen installed globally, you can use `git commit too`).
20+
- We will eventually have a linter installed - please follow the linter rules when contributing.
21+
- We will eventually have tests - please make sure your code passes the tests before opening a pull request.
22+
- We will eventually have a code of conduct - please follow the code of conduct when contributing.

LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2023 dotsui-design
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 44 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,45 @@
1-
# dots ui (React)
1+
<h1 align="center">Dots UI</h1>
22

3-
## Getting Started
3+
<p align="center">
4+
<img src="https://img.shields.io/github/license/dotsui-design/dots-react" alt="License">
5+
<img src="https://img.shields.io/github/last-commit/dotsui-design/dots-react" alt="Last commit">
6+
<img src="https://img.shields.io/github/actions/workflow/status/dotsui-design/dots-react/publish-to-npm.yml?logo=github" alt="Build status">
7+
<img src="https://img.shields.io/github/v/release/dotsui-design/dots-react?include_prereleases" alt="Release">
8+
<img src="https://img.shields.io/npm/v/@dots-ui/react?include_prereleases" alt="NPM version">
9+
<img src="https://img.shields.io/npm/dt/@dots-ui/react" alt="NPM downloads">
10+
<img src="https://img.shields.io/badge/PRs-welcome-brightgreen.svg" alt="PRs welcome">
11+
</p>
12+
13+
<p align="center">
14+
<a href="https://dotsui.design/docs">Documentation</a> •
15+
<a href="https://github.com/dotsui-design/dots-react/issues">Issues</a> •
16+
<a href="https://github.com/dotsui-design/dots-react/tree/main/CONTRIBUTING.md">Contributing</a>
17+
</p>
18+
19+
<p align="center">
20+
<img src="https://raw.githubusercontent.com/dotsui-design/dots-react/main/.github/assets/dotsui-logo.png" alt="Dots UI" width="100%">
21+
</p>
22+
23+
## Introduction
24+
25+
Dots UI is a design system for building beautiful websites and applications. It is built on top of [React](https://reactjs.org/) and [Styled Components](https://styled-components.com/). It is a collection of reusable components that can be used to build websites and applications. It is designed to be beautiful and feature-rich.
26+
27+
Note: We are still in the early stages of development. We are working on adding more components and features. If you would like to contribute, please read our [contributing guidelines](https://github.com/dotsui-design/dots-react/tree/main/CONTRIBUTING.md).
28+
29+
## Installation
30+
31+
To install Dots UI, run the following command:
32+
33+
```bash
34+
yarn add @dots-ui/react
35+
# or
36+
npm install @dots-ui/react
37+
```
38+
39+
## Documentation
40+
41+
A website with documentation is coming soon. It will be available at [dotsui.design](https://dotsui.design/). If you want to help contribute to the documentation, check out the repository [here](https://github.com/dotsui-design/dotsui-docs).
42+
43+
## Suggestions
44+
45+
If you have any suggestions for Dots UI, please open an issue [here](https://github.com/dotsui-design/dots-react/issues/new). We would love to hear your feedback! (Or feel free to open a pull request if you want to contribute!)

0 commit comments

Comments
 (0)