diff --git a/ci/.github/ISSUE_TEMPLATE/suggestion.yaml b/.github/ISSUE_TEMPLATE/suggestion.yaml similarity index 100% rename from ci/.github/ISSUE_TEMPLATE/suggestion.yaml rename to .github/ISSUE_TEMPLATE/suggestion.yaml diff --git a/.github/workflows/lint.yaml b/.github/workflows/lint.yaml index fae0ac5..5e51d3a 100644 --- a/.github/workflows/lint.yaml +++ b/.github/workflows/lint.yaml @@ -11,7 +11,7 @@ jobs: fail-fast: false matrix: files: - - "readme-template.md" + - "readme.md" runs-on: ubuntu-latest steps: - name: "checkout repo" @@ -27,7 +27,7 @@ jobs: fail-fast: false matrix: files: - - "readme-template.md" + - "readme.md" runs-on: ubuntu-latest steps: - name: "checkout repo" @@ -42,4 +42,4 @@ jobs: - name: "install awesome-bot" run: gem install awesome_bot - name: "linting: ${{ matrix.files }}" - run: awesome_bot --allow-redirect --white-list https://github.com/YOUR_GITHUB_USER/YOUR_REPO ${{ matrix.files }} + run: awesome_bot --allow-redirect ${{ matrix.files }} diff --git a/ci/.github/workflows/lint.yaml b/ci/.github/workflows/lint.yaml deleted file mode 100644 index a271c1d..0000000 --- a/ci/.github/workflows/lint.yaml +++ /dev/null @@ -1,45 +0,0 @@ -name: lint -on: - pull_request: - push: - branches: - - main - -jobs: - awesome-lint: - strategy: - fail-fast: false - matrix: - files: - - "readme-template.md" - runs-on: ubuntu-latest - steps: - - name: "checkout repo" - uses: actions/checkout@v2 - with: - fetch-depth: 0 - - name: asdf_install - uses: asdf-vm/actions/install@v1 - - name: "linting: ${{ matrix.files }}" - run: npx -y awesome-lint ${{ matrix.files }} - awesome-bot: - strategy: - fail-fast: false - matrix: - files: - - "readme-template.md" - runs-on: ubuntu-latest - steps: - - name: "checkout repo" - uses: actions/checkout@v2.0.0 - with: - fetch-depth: 0 - - name: "setup ruby" - uses: ruby/setup-ruby@v1 - with: - ruby-version: 3.0.1 - bundler-cache: true - - name: "install awesome-bot" - run: gem install awesome_bot - - name: "linting: ${{ matrix.files }}" - run: awesome_bot --allow-redirect ${{ matrix.files }} diff --git a/contributing.md b/contributing.md index 6b3a2a1..510ec46 100644 --- a/contributing.md +++ b/contributing.md @@ -8,7 +8,7 @@ ALWAYS create a new branch with your proposed changes. Thank you! ## Adding an new Item -- Try to fit your item into an existing sections. [Open a suggestion](https://github.com/YOUR_GITHUB_USER/YOUR_REPO/issues/new) to start as discussion about any new sections. +- Try to fit your item into an existing sections. [Open a suggestion](https://github.com/grayhatdevelopers/awesome-playroom/issues/new) to start as discussion about any new sections. - Add a new item to the bottom of the list in a section. - If a duplicate item exists, discuss why the new item should replace it. - Check your spelling & grammar. diff --git a/readme-template.md b/readme-template.md deleted file mode 100644 index 31242a5..0000000 --- a/readme-template.md +++ /dev/null @@ -1,59 +0,0 @@ -
- - - - - -# Awesome List Template [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) [![lint](https://github.com/YOUR_GITHUB_USER/YOUR_REPO/actions/workflows/lint.yaml/badge.svg)](https://github.com/YOUR_GITHUB_USER/YOUR_REPO/actions/workflows/lint.yaml) - - - -A template for an awesome list with required conventions out of the box! - - - - - - - - - -A one line description of the product or tool. See -[awesome-firebase](https://github.com/jthegedus/awesome-firebase) for an -example. - -
- - - -## Contents - -- [Featured (new releases)](#featured-new-releases) -- [Section 1](#section-1) -- [Follow](#follow) - - - -## Featured (new releases) - -- [Apple](https://apple.com) - Apple as a placeholder. - -## Section 1 - -- [Microsoft](https://www.microsoft.com/) - Microsoft as an example. - - - -## Follow - - - -Who else should we be following!? - -## Contributing - -[Contributions of any kind welcome, just follow the guidelines](contributing.md)! - -### Contributors - -[Thanks goes to these contributors](https://github.com/YOUR_GITHUB_USER/YOUR_REPO/graphs/contributors)! diff --git a/readme.md b/readme.md index a33271e..958c0aa 100644 --- a/readme.md +++ b/readme.md @@ -1,30 +1,63 @@ -# Awesome List Template - -This is an [awesome-list](https://github.com/sindresorhus/awesome) template with -CI to run [awesome-lint](https://github.com/sindresorhus/awesome-lint) and -[awesome_bot](https://github.com/dkhamsing/awesome_bot) to be compliant from the -beginning. - -## Usage - -1. [generate a template of this repo](https://github.com/jthegedus/awesome-list-template/generate) -2. run a find & replace of `YOUR_GITHUB_USER/YOUR_REPO` with your details -3. edit `readme-template.md` - - update the h1 title - - update the subtitle - - update the description - - add img src, make it link to the site of the thing in the image. -4. choose a CI template - - GitHub Action: move config folder from `repo-root/ci/.github/` to - `repo-root/.github` - - Circle CI: move config folder from `repo-root/ci/.circleci/*` to - `repo-root/.circleci/*` - - GitLab CI: move config file from `repo-root/ci/.gitlab-ci.yml` to the - `repo-root/.gitlab-ci.yml` -5. run a find & replace `readme-template.md` to `readme.md` in the CI you chose -5. delete this file -6. rename `readme-template.md` file to `readme.md` +
+ + + + + +# 🏁 Awesome Playroom [![Awesome](https://awesome.re/badge.svg)](https://awesome.re) [![lint](https://github.com/grayhatdevelopers/awesome-playroom/actions/workflows/lint.yaml/badge.svg)](https://github.com/grayhatdevelopers/awesome-playroom/actions/workflows/lint.yaml) + + + +An awesome list for everything Playroom, the multiplayer library! + + + + + + + + + +PlayroomKit is a product of Playroom, which greatly accelerates web game dev by making games multiplayer within just a few lines. See +[their website](https://joinplayroom.com) for more info. + +
+ + + +## Contents + +- [Featured (new releases)](#featured-new-releases) +- [Open source games](#open-source-games) +- [Follow](#follow) + + + +## Featured (new releases) + +- [Playroom Docs](https://docs.joinplayroom.com) - The official documentation of PlayroomKit + +## Open source games + +- [Platformer.ai](https://github.com/Muhammad-Saad12/platformer.ai) - A Mario-like N player sample cast game for PlayroomKit. + +## Boilerplates + +- [create-multiplayer-game](https://github.com/grayhatdevelopers/create-multiplayer-game) - Create a multiplayer web game in seconds πŸ‘ΎπŸš€ + + + +## Follow + + + +- Tabish Ahmed ([Twitter](https://twitter.com/TaabiTweets)) +- Asad Memon ([Twitter](https://twitter.com/_asadmemon)) ## Contributing -Contributions welcome! +[Contributions of any kind welcome, just follow the guidelines](contributing.md)! + +### Contributors + +[Thanks goes to these contributors](https://github.com/grayhatdevelopers/awesome-playroom/graphs/contributors)!