Skip to content

Commit

Permalink
docs: Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
schmelto committed Nov 25, 2023
1 parent e3cb628 commit da9701c
Showing 1 changed file with 3 additions and 29 deletions.
32 changes: 3 additions & 29 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,44 +15,18 @@ The website is deployed to **GitHub Pages** and can be found [here](https://schm

### Install and develop on local machine

To run the project locally on your computer please clone the project using this command `git clone` and run `npm install` to install all required dependencies.
To run the project locally on your computer please clone the project using this command `git clone` and run `npm ci` to install all required dependencies.

> This Project uses **[ESLint](https://eslint.org/)** and **[Prettier](https://prettier.io/)**.
Due the project only uses _HTML_, _CSS_ and _JavaScript_ you can access the website on you local machine by opening the `index.html`-file with your favorite browser or by running `npm start`.

### Add another project to the website

The projects shown on the website are being accessed through the [GitHub API](https://docs.github.com/en/rest) and can be maintained by modifing the [scripts.js](./js/scripts.js).

```js
let githubprojects = [
{
name: 'schmelto/100-days-of-code',
icon: 'description',
},
];
```

- **name**: username/repository (GitHub)
- **icon**: icon you want to display for the project (using [Google Font Icons](https://fonts.google.com/icons))

> Due to lots of projects using icons in their project description the script in [js/scripts.js](./js/scripts.js) remove the github icons.
>
> ```js
> project.description.replace(/:[^}]*:/, '');
> ```
## Contribute
If you want to contribute to this project and make it better, your help is very welcome.
### Want to Help?

Want to file a bug, contribute some code, or improve documentation? Excellent! Check out one of our [issues](https://github.com/schmelto/Portfolio/issues).
Want to file a bug, contribute some code, or improve documentation? Excellent! Check out one of the [issues](https://github.com/schmelto/Portfolio/issues).

### Code of Conduct

Help us keep this project open and inclusive. Please read and follow our [Code of Conduct](./CODE_OF_CONDUCT.md).
Help me keep this project open and inclusive. Please read and follow the [Code of Conduct](./CODE_OF_CONDUCT.md).

### Love this project? Consider giving it a ⭐

0 comments on commit da9701c

Please sign in to comment.