Skip to content

Commit

Permalink
chores: add readme and license
Browse files Browse the repository at this point in the history
  • Loading branch information
0x5ea000000 committed Feb 22, 2024
1 parent 5299d18 commit 414c0b2
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 0 deletions.
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) [2024] [haipro287]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
65 changes: 65 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Rust-based Ultimate Support Hub (rush)

A brief description of your project goes here.

## Table of Contents

- [Installation](#installation)
- [Usage](#usage)
- [Contributing](#contributing)
- [License](#license)

## Installation

Ensure you have Rust and Cargo installed on your system. You can install them by following the instructions on [rust-lang.org](https://www.rust-lang.org/learn/get-started).

Clone this repository to your local machine:

```sh
git clone https://github.com/haipro287/rush.git
cd rush
```

## Usage

### Running the Project

Follow these steps to run the project:

1. Navigate to the project directory in your terminal.

2. Build the project using Cargo:

```sh
cargo build
```

3. Run the project:

```sh
cargo run
```

### Running Tests

To run tests, use Cargo's built-in testing feature:

```sh
cargo test
```

### Example Usage

If applicable, provide an example of how to use your project:

```sh
# Example command or code snippet
```

## Contributing

Contributions are welcome! If you'd like to contribute to this project, feel free to submit a pull request. Please follow the [Contributing Guidelines](CONTRIBUTING.md).

## License

This project is licensed under the [MIT License](LICENSE).

0 comments on commit 414c0b2

Please sign in to comment.