Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
dubpixel authored Sep 21, 2024
1 parent edb76cd commit e6fbd7e
Showing 1 changed file with 12 additions and 41 deletions.
53 changes: 12 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
<!-- PROJECT LOGO -->
<br />
<div align="center">
<a href="https://github.com/dubpixek/DPX_SOLDER_555">
<a href="https://github.com/dubpixel/DPX_SOLDER_555">
<img src="images/logo.png" alt="Logo" width="80" height="80">
</a>

Expand All @@ -40,14 +40,14 @@
<p align="center">
project_description
<br />
<a href="https://github.com/github_username/repo_name"><strong>Explore the docs »</strong></a>
<a href="https://github.com/dubpixel/DPX_SOLDER_555"><strong>Explore the docs »</strong></a>
<br />
<br />
<a href="https://github.com/github_username/repo_name">View Demo</a>
<a href="https://github.com/dubpixel/DPX_SOLDER_555">View Demo</a>
·
<a href="https://github.com/github_username/repo_name/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
<a href="https://github.com/dubpixel/DPX_SOLDER_555/issues/new?labels=bug&template=bug-report---.md">Report Bug</a>
·
<a href="https://github.com/github_username/repo_name/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
<a href="https://github.com/dubpixel/DPX_SOLDER_555/issues/new?labels=enhancement&template=feature-request---.md">Request Feature</a>
</p>
</div>

Expand Down Expand Up @@ -110,42 +110,13 @@ Here's a blank template to get started: To avoid retyping too much info. Do a se
<!-- GETTING STARTED -->
## Getting Started

This is an example of how you may give instructions on setting up your project locally.
To get a local copy up and running follow these simple example steps.

### Prerequisites

This is an example of how to list things you need to use the software and how to install them.
* npm
```sh
npm install npm@latest -g
```

### Installation

1. Get a free API Key at [https://example.com](https://example.com)
2. Clone the repo
```sh
git clone https://github.com/github_username/repo_name.git
```
3. Install NPM packages
```sh
npm install
```
4. Enter your API in `config.js`
```js
const API_KEY = 'ENTER YOUR API';
```
5. Change git remote url to avoid accidental pushes to base project
```sh
git remote set-url origin github_username/repo_name
git remote -v # confirm the changes
```

<p align="right">(<a href="#readme-top">back to top</a>)</p>



1.
<!-- USAGE EXAMPLES -->
## Usage

Expand All @@ -165,7 +136,7 @@ _For more examples, please refer to the [Documentation](https://example.com)_
- [ ] Feature 3
- [ ] Nested Feature

See the [open issues](https://github.com/github_username/repo_name/issues) for a full list of proposed features (and known issues).
See the [open issues](https://github.com/dubpixel/DPX_SOLDER_555/issues) for a full list of proposed features (and known issues).

<p align="right">(<a href="#readme-top">back to top</a>)</p>

Expand Down Expand Up @@ -228,12 +199,12 @@ Project Link: [https://github.com/github_username/repo_name](https://github.com/

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/github_username/repo_name.svg?style=for-the-badge
[contributors-url]: https://github.com/github_username/repo_name/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/github_username/repo_name.svg?style=for-the-badge
[forks-url]: https://github.com/github_username/repo_name/network/members
[contributors-shield]: https://img.shields.io/github/contributors/dubpixel/DPX_SOLDER_555.svg?style=for-the-badge
[contributors-url]: https://github.com/dubpixel/DPX_SOLDER_555/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/gdubpixel/DPX_SOLDER_555.svg?style=for-the-badge
[forks-url]: https://github.com/dubpixel/DPX_SOLDER_555/network/members
[stars-shield]: https://img.shields.io/github/stars/github_username/repo_name.svg?style=for-the-badge
[stars-url]: https://github.com/github_username/repo_name/stargazers
[stars-url]: https://github.com/dubpixel/DPX_SOLDER_555/stargazers
[issues-shield]: https://img.shields.io/github/issues/github_username/repo_name.svg?style=for-the-badge
[issues-url]: https://github.com/github_username/repo_name/issues
[license-shield]: https://img.shields.io/github/license/github_username/repo_name.svg?style=for-the-badge
Expand Down

0 comments on commit e6fbd7e

Please sign in to comment.