Skip to content

Commit

Permalink
docs: update content
Browse files Browse the repository at this point in the history
  • Loading branch information
alexwine36 committed Aug 26, 2024
1 parent e16c739 commit ba12908
Showing 1 changed file with 28 additions and 32 deletions.
60 changes: 28 additions & 32 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -111,13 +111,10 @@ This repository contains... [ Briefly describe what the project is about ]
This section should list any major frameworks/libraries used to bootstrap your project. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

[![Next][Next.js]][Next-url]
* [![React][React.js]][React-url]
* [![Vue][Vue.js]][Vue-url]
* [![Angular][Angular.io]][Angular-url]
* [![Svelte][Svelte.dev]][Svelte-url]
* [![Laravel][Laravel.com]][Laravel-url]
* [![Bootstrap][Bootstrap.com]][Bootstrap-url]
* [![JQuery][JQuery.com]][JQuery-url]
[![React][React.js]][React-url]
[![Rust][Rust]][Rust-url]
[![Moon][Moon]][Moon-url]


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

Expand All @@ -126,33 +123,39 @@ This section should list any major frameworks/libraries used to bootstrap your p
<!-- 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
```
Install moon - [instructions](https://moonrepo.dev/docs/install)

```sh
moon setup
```


Run dev servers
```sh
moon :dev
```

### Installation

_Below is an example of how you can instruct your audience on installing and setting up your app. This template doesn't rely on any external dependencies or services._

1. Get a free API Key at [https://example.com](https://example.com)
2. Clone the repo

1. Clone the repo
```sh
git clone https://github.com/alexwine36/Moon-Repo-Test.git
```
3. Install NPM packages
2. Initialize Moon
```sh
npm install
moon setup
```
4. Enter your API in `config.js`
```js
const API_KEY = 'ENTER YOUR API';
3. Run tests
```sh
moon :dev
```

<p align="right">(<a href="#readme-top">back to top</a>)</p>
Expand Down Expand Up @@ -262,18 +265,11 @@ Use this space to list resources you find helpful and would like to give credit
[Next-url]: https://nextjs.org/
[React.js]: https://img.shields.io/badge/React-20232A?style=for-the-badge&logo=react&logoColor=61DAFB
[React-url]: https://reactjs.org/
[Vue.js]: https://img.shields.io/badge/Vue.js-35495E?style=for-the-badge&logo=vuedotjs&logoColor=4FC08D
[Vue-url]: https://vuejs.org/
[Angular.io]: https://img.shields.io/badge/Angular-DD0031?style=for-the-badge&logo=angular&logoColor=white
[Angular-url]: https://angular.io/
[Svelte.dev]: https://img.shields.io/badge/Svelte-4A4A55?style=for-the-badge&logo=svelte&logoColor=FF3E00
[Svelte-url]: https://svelte.dev/
[Laravel.com]: https://img.shields.io/badge/Laravel-FF2D20?style=for-the-badge&logo=laravel&logoColor=white
[Laravel-url]: https://laravel.com
[Bootstrap.com]: https://img.shields.io/badge/Bootstrap-563D7C?style=for-the-badge&logo=bootstrap&logoColor=white
[Bootstrap-url]: https://getbootstrap.com
[JQuery.com]: https://img.shields.io/badge/jQuery-0769AD?style=for-the-badge&logo=jquery&logoColor=white
[JQuery-url]: https://jquery.com
[Rust]: https://img.shields.io/badge/Rust-CE412B?style=for-the-badge&logo=rust&logoColor=white
[Rust-url]: https://www.rust-lang.org/
[Moon]: https://img.shields.io/badge/Moonrepo-6e58d1?style=for-the-badge&logo=moonrepo&logoColor=white
[Moon-url]: https://moonrepo.dev/




Expand Down

0 comments on commit ba12908

Please sign in to comment.