Skip to content
This repository has been archived by the owner on Jan 19, 2024. It is now read-only.

Commit

Permalink
docs: readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nxzq committed Jan 18, 2024
1 parent e7cb9d3 commit 46f8ca2
Show file tree
Hide file tree
Showing 6 changed files with 35 additions and 97 deletions.
53 changes: 14 additions & 39 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,18 @@
# inhouse-scrims

<p>
<a href="https://nxzq.github.io/inhouse-scrims" alt="GitHub Pages">
<img src="https://img.shields.io/badge/pages%20-nxzq.github.io/inhouse--scrims-%23222222?logo=github&style=flat-square" />
</a>
</p>
<p>
<a href='https://reactjs.org/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/React-%23545455?logo=react&style=flat-square' alt='react'/>
</a>
<a href='https://tailwindcss.com/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/Tailwind-%23545455?logo=tailwindcss&style=flat-square' alt='tailwindcss'/>
</a>
<a href='https://www.javascript.com/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/JavaScript-%23545455?logo=javascript&style=flat-square' alt='javascript'/>
</a>
<a href='https://www.typescriptlang.org/docs/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/TypeScript-%23545455?logo=typescript&style=flat-square' alt='typescript'/>
</a>
<a href='https://vitejs.dev/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/Vite-%23545455?logo=vite&style=flat-square' alt='vite'/>
</a>
<a href='https://vitest.dev/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/Vitest-%23545455?logo=vitest&style=flat-square' alt='vitest'/>
</a>
<a href='https://prettier.io/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/Prettier-%23545455?logo=prettier&style=flat-square' alt='prettier'/>
</a>
<a href='https://eslint.org/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/ESLint-%23545455?logo=eslint&style=flat-square' alt='eslint'/>
</a>
<a href='https://typicode.github.io/husky/#/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/husky-%23545455?logo=git&style=flat-square' alt='husky'/>
</a>
<a href='https://commitlint.js.org/#/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/commitlint-%23545455?logo=commitlint&style=flat-square' alt='commitlint'/>
</a>
</p>
[![GitHub Pages](https://img.shields.io/badge/pages%20-nxzq.github.io/inhouse--scrims-%23222222?logo=github&style=flat-square)](https://nxzq.github.io/inhouse-scrims)

![demo](https://raw.githubusercontent.com/nxzq/misc/main/inhouse-scrims/demo.gif)
[![react](https://img.shields.io/badge/React-%23545455?logo=react&style=flat-square)](https://reactjs.org/)
[![tailwindcss](https://img.shields.io/badge/Tailwind-%23545455?logo=tailwindcss&style=flat-square)](https://tailwindcss.com/)
[![javascript](https://img.shields.io/badge/JavaScript-%23545455?logo=javascript&style=flat-square)](https://www.javascript.com/)
[![typescript](https://img.shields.io/badge/TypeScript-%23545455?logo=typescript&style=flat-square)](https://www.typescriptlang.org/docs/)
[![vite](https://img.shields.io/badge/Vite-%23545455?logo=vite&style=flat-square)](https://vitejs.dev/)
[![vitest](https://img.shields.io/badge/Vitest-%23545455?logo=vitest&style=flat-square)](https://vitest.dev/)
[![prettier](https://img.shields.io/badge/Prettier-%23545455?logo=prettier&style=flat-square)](https://prettier.io/)
[![eslint](https://img.shields.io/badge/ESLint-%23545455?logo=eslint&style=flat-square)](https://eslint.org/)
[![husky](https://img.shields.io/badge/husky-%23545455?logo=git&style=flat-square)](https://typicode.github.io/husky/#/)
[![commitlint](https://img.shields.io/badge/commitlint-%23545455?logo=commitlint&style=flat-square)](https://commitlint.js.org/#/)

League of Legends inhouse matchmaking solution. Attempts to honor role preference while also minimizing team MMR Δ & lane MMR Δ (Lane Diff). Learn more about the [algorithm here](/modules/generator/README.md).
![demo](/demo.gif)

League of Legends inhouse matchmaking solution. Attempts to honor role preference while also minimizing team MMR Δ & lane MMR Δ (Lane Diff). Learn more about the [algorithm here](/modules/generator/README.md)
Binary file added demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
43 changes: 11 additions & 32 deletions modules/app/README.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,17 @@
# inhouse-scrims-app

<p>
<a href="https://inhousescrims.com" alt="GitHub Pages">
<img src="https://img.shields.io/badge/pages%20-nxzq.github.io/inhouse--scrims-%23222222?logo=github&style=flat-square" />
</a>
</p>
<p>
<a href='https://reactjs.org/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/React-%23545455?logo=react&style=flat-square' alt='react'/>
</a>
<a href='https://tailwindcss.com/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/Tailwind-%23545455?logo=tailwindcss&style=flat-square' alt='tailwindcss'/>
</a>
<a href='https://www.javascript.com/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/JavaScript-%23545455?logo=javascript&style=flat-square' alt='javascript'/>
</a>
<a href='https://vitejs.dev/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/Vite-%23545455?logo=vite&style=flat-square' alt='vite'/>
</a>
<a href='https://prettier.io/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/Prettier-%23545455?logo=prettier&style=flat-square' alt='prettier'/>
</a>
<a href='https://eslint.org/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/ESLint-%23545455?logo=eslint&style=flat-square' alt='eslint'/>
</a>
<a href='https://typicode.github.io/husky/#/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/husky-%23545455?logo=git&style=flat-square' alt='husky'/>
</a>
<a href='https://commitlint.js.org/#/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/commitlint-%23545455?logo=commitlint&style=flat-square' alt='commitlint'/>
</a>
</p>
[![GitHub Pages](https://img.shields.io/badge/pages%20-nxzq.github.io/inhouse--scrims-%23222222?logo=github&style=flat-square)](https://nxzq.github.io/inhouse-scrims)

Web (React app) interface for inhouse-scrims.
[![react](https://img.shields.io/badge/React-%23545455?logo=react&style=flat-square)](https://reactjs.org/)
[![tailwindcss](https://img.shields.io/badge/Tailwind-%23545455?logo=tailwindcss&style=flat-square)](https://tailwindcss.com/)
[![javascript](https://img.shields.io/badge/JavaScript-%23545455?logo=javascript&style=flat-square)](https://www.javascript.com/)
[![vite](https://img.shields.io/badge/Vite-%23545455?logo=vite&style=flat-square)](https://vitejs.dev/)
[![prettier](https://img.shields.io/badge/Prettier-%23545455?logo=prettier&style=flat-square)](https://prettier.io/)
[![eslint](https://img.shields.io/badge/ESLint-%23545455?logo=eslint&style=flat-square)](https://eslint.org/)
[![husky](https://img.shields.io/badge/husky-%23545455?logo=git&style=flat-square)](https://typicode.github.io/husky/#/)
[![commitlint](https://img.shields.io/badge/commitlint-%23545455?logo=commitlint&style=flat-square)](https://commitlint.js.org/#/)

Web (React app) interface for inhouse-scrims

## Getting Started

Expand Down
4 changes: 2 additions & 2 deletions modules/app/package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "inhouse-scrims-app",
"version": "0.1.0",
"version": "0.0.0",
"homepage": "nxzq.github.io/inhouse-scrims/",
"private": true,
"private": false,
"dependencies": {
"clsx": "^1.1.1",
"react": "^17.0.2",
Expand Down
30 changes: 7 additions & 23 deletions modules/generator/README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,12 @@
# inhouse-scrims

<p>
<a href='https://www.typescriptlang.org/docs/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/TypeScript-%23545455?logo=typescript&style=flat-square' alt='typescript'/>
</a>
<a href='https://vitejs.dev/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/Vite-%23545455?logo=vite&style=flat-square' alt='vite'/>
</a>
<a href='https://vitest.dev/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/Vitest-%23545455?logo=vitest&style=flat-square' alt='vitest'/>
</a>
<a href='https://prettier.io/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/Prettier-%23545455?logo=prettier&style=flat-square' alt='prettier'/>
</a>
<a href='https://eslint.org/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/ESLint-%23545455?logo=eslint&style=flat-square' alt='eslint'/>
</a>
<a href='https://typicode.github.io/husky/#/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/husky-%23545455?logo=git&style=flat-square' alt='husky'/>
</a>
<a href='https://commitlint.js.org/#/' target="_blank" rel="noopener noreferrer">
<img src='https://img.shields.io/badge/commitlint-%23545455?logo=commitlint&style=flat-square' alt='commitlint'/>
</a>
</p>
[![typescript](https://img.shields.io/badge/TypeScript-%23545455?logo=typescript&style=flat-square)](https://www.typescriptlang.org/docs/)
[![vite](https://img.shields.io/badge/Vite-%23545455?logo=vite&style=flat-square)](https://vitejs.dev/)
[![vitest](https://img.shields.io/badge/Vitest-%23545455?logo=vitest&style=flat-square)](https://vitest.dev/)
[![prettier](https://img.shields.io/badge/Prettier-%23545455?logo=prettier&style=flat-square)](https://prettier.io/)
[![eslint](https://img.shields.io/badge/ESLint-%23545455?logo=eslint&style=flat-square)](https://eslint.org/)
[![husky](https://img.shields.io/badge/husky-%23545455?logo=git&style=flat-square)](https://typicode.github.io/husky/#/)
[![commitlint](https://img.shields.io/badge/commitlint-%23545455?logo=commitlint&style=flat-square)](https://commitlint.js.org/#/)

League of Legends inhouse matchmaking solution. Attempts to honor role preference while also minimizing team MMR Δ & lane MMR Δ (Lane Diff). Takes an array of player objects and returns an array of suitable lobbies sorted.

Expand Down
2 changes: 1 addition & 1 deletion modules/generator/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "inhouse-scrims-algorithm",
"version": "1.0.0",
"version": "0.0.0",
"type": "module",
"exports": {
".": {
Expand Down

0 comments on commit 46f8ca2

Please sign in to comment.