Skip to content

Commit

Permalink
Updated project info
Browse files Browse the repository at this point in the history
  • Loading branch information
chocoearly44 committed Jul 30, 2022
1 parent 1c92cfe commit 359f2d0
Show file tree
Hide file tree
Showing 4 changed files with 51 additions and 35 deletions.
14 changes: 14 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
## Contributing
### Requirements
- [Node.js](https://nodejs.org)
- [NPM](https://www.npmjs.com)
- [Yeoman](https://yeoman.io/)

If you have a suggestion that would make this better, please fork the repo and create a pull request.
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Added some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
45 changes: 10 additions & 35 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<p align="center">
<img align="center" src="images/bsoverlay-icon.png" height="150px">
<img align="center" src="./assets/icon.svg" height="150px">
</p>

<h1 align="center">BSOverlay</h1>
<h3 align="center">VSCode extension that creates an overlay for your Broadcasting Software of choice.
</h3>
<h3 align="center">VSCode extension that creates an overlay for your Broadcasting Software of choice.</h3>
<br>

<div align="center">

[![Installs][marketplace-shield]][marketplace-url]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
Expand All @@ -21,57 +21,32 @@
Please refer to the [Wiki Section][wiki-url].

## Installation
![][linux-shield]
![][windows-shield]
![][macos-shield]

Press `F1` in VSCode and type `ext install chocoearly44.bsoverlay`

**OR**

Install from [Extension store](https://marketplace.visualstudio.com/items?itemName=chocoearly44.bsoverlay)

### Requirements
- [Visual Studio Code](https://code.visualstudio.com)

## Contributing
### Requirements
- [Node.js](https://nodejs.org)
- [NPM](https://www.npmjs.com)
- [Yeoman](https://yeoman.io/)

If you have a suggestion that would make this better, please fork the repo and create a pull request.
Don't forget to give the project a star! Thanks again!

1. Fork the Project
2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)
3. Commit your Changes (`git commit -m 'Added some AmazingFeature'`)
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request
Install from [Extension store][marketplace-url]

## Bug reporting
If you encounter any bugs while using the tools please report them in the [Issues Section][issues-url] on GitHub Repository.
If you encounter any bugs while using BSOverlay, please report them in the [Issues Section][issues-url].

## Support
You can receive additional support in an official Discord Server or in a [Discussions Section][discussions-url] here on GitHub.

[![Widget for the TSL Support guild](https://discord.com/api/guilds/807666401300316160/widget.png?style=banner1)](https://discord.gg/Wa24skGscR)
You can receive additional support in a [Discussions Section][discussions-url].

[contributors-shield]: https://img.shields.io/github/contributors/chocoearly44/bsoverlay-vscode.svg?style=for-the-badge
[forks-shield]: https://img.shields.io/github/forks/chocoearly44/bsoverlay-vscode.svg?style=for-the-badge
[stars-shield]: https://img.shields.io/github/stars/chocoearly44/bsoverlay-vscode.svg?style=for-the-badge
[issues-shield]: https://img.shields.io/github/issues/chocoearly44/bsoverlay-vscode.svg?style=for-the-badge
[license-shield]: https://img.shields.io/github/license/chocoearly44/bsoverlay-vscode.svg?style=for-the-badge

[linux-shield]: https://img.shields.io/badge/Linux-Yes-green?style=for-the-badge&logo=linux
[windows-shield]: https://img.shields.io/badge/Windows-Yes-green?style=for-the-badge&logo=windows
[macos-shield]: https://img.shields.io/badge/MacOs-Yes-green?style=for-the-badge&logo=apple

[contributors-url]: https://github.com/chocoearly44/bsoverlay-vscode/graphs/contributors
[forks-url]: https://github.com/chocoearly44/bsoverlay-vscode/network/members
[stars-url]: https://github.com/chocoearly44/bsoverlay-vscode/stargazers
[issues-url]: https://github.com/chocoearly44/bsoverlay-vscode/issues
[license-url]: https://github.com/chocoearly44/bsoverlay-vscode/blob/master/LICENSE
[wiki-url]: https://github.com/chocoearly44/bsoverlay-vscode/wiki
[releases-url]: https://github.com/chocoearly44/bsoverlay-vscode/releases
[discussions-url]: https://github.com/chocoearly44/bsoverlay-vscode/discussions
[discussions-url]: https://github.com/chocoearly44/bsoverlay-vscode/discussions

[marketplace-shield]: https://img.shields.io/visual-studio-marketplace/i/chocoearly44.bsoverlay.svg?style=for-the-badge
[marketplace-url]: https://marketplace.visualstudio.com/items?itemName=chocoearly44.bsoverlay
27 changes: 27 additions & 0 deletions assets/icon.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed images/bsoverlay-icon.png
Binary file not shown.

0 comments on commit 359f2d0

Please sign in to comment.