Skip to content

Commit

Permalink
docs: reference derived work
Browse files Browse the repository at this point in the history
  • Loading branch information
aidenybai committed Feb 25, 2022
1 parent 19522e2 commit ba3a768
Show file tree
Hide file tree
Showing 10 changed files with 33 additions and 113 deletions.
16 changes: 10 additions & 6 deletions README.md
Expand Up @@ -44,7 +44,7 @@ Million aims to fix this, providing a **library-agnostic** Virtual DOM to serve
Inside your project directory, run the following command:

```sh
npm install million # yarn add million
npm install million
```

## Quick Start
Expand All @@ -54,7 +54,7 @@ Below is an extremely simple implementation of a Hello World page using Million.
```js
import { m, render } from 'million';

render(document.body, m('p', undefined, ['Hello World!']));
render(document.body, m('h1', undefined, ['Hello World!']));

// <p>Hello World</p> rendered to <body>
```
Expand Down Expand Up @@ -83,9 +83,7 @@ We expect all Million contributors to abide by the terms of our [Code of Conduct

Million takes heavy inspiration from [snabbdom](https://github.com/snabbdom/snabbdom), [ivi](https://github.com/localvoid/ivi), [mikado](https://github.com/nextapps-de/mikado), [and more](https://krausest.github.io/js-framework-benchmark/2021/table_chrome_96.0.4664.45.html). Feel free to check them out if you interested in an alternative library to use.

_Why is it called "Million"? The name originated with the goal of being able to handle [1M+ ops/sec for benchmarks](https://github.com/aidenybai/million/tree/main/benchmarks#readme)._

_What is the logo? The logo stems from the suffix of Mil**LION**, and is a graphic of the nose and mouth of a lion._
Million is being used by open source tools like [tinypages](https://github.com/Borrus-sudo/tinypages), [hacky](https://github.com/aidenybai/hacky), and [others](https://github.com/aidenybai/million/network/dependents).

## Sponsors

Expand All @@ -95,6 +93,12 @@ _What is the logo? The logo stems from the suffix of Mil**LION**, and is a graph

## License

Million is [MIT-licensed](LICENSE) open-source software and [research project](https://arxiv.org/abs/2202.08409) by [Aiden Bai](https://github.com/aidenybai).
Million is [MIT-licensed](LICENSE) open-source software and [research project](https://arxiv.org/abs/2202.08409) by [Aiden Bai](https://aidenybai.com).

---

_Why is it called "Million"? The name originated with the goal of being able to handle [1M+ ops/sec for benchmarks](https://github.com/aidenybai/million/tree/main/benchmarks#readme)._

_What is the logo? The logo stems from the suffix of Mil**LION**, and is a graphic of the nose and mouth of a lion._

![View count](https://hits.link/hits?url=https://github.com/aidenybai/million&bgRight=000&bgLeft=000)
2 changes: 1 addition & 1 deletion package.json
Expand Up @@ -91,7 +91,7 @@
"@types/benchmark": "^2.1.1",
"@types/canvas-confetti": "^1.4.2",
"@types/lodash": "^4.14.178",
"@types/node": "^17.0.19",
"@types/node": "^17.0.21",
"@types/virtual-dom": "^2.1.1",
"@typescript-eslint/eslint-plugin": "^5.12.1",
"@typescript-eslint/parser": "^5.12.1",
Expand Down
2 changes: 1 addition & 1 deletion packages/block/README.md
Expand Up @@ -4,4 +4,4 @@ Adds [blockdom-like](https://github.com/ged-odoo/blockdom) support for Million,

## License

Million is [MIT-licensed](../../../LICENSE) open-source software and [research](https://arxiv.org/abs/2202.08409) by [Aiden Bai](https://github.com/aidenybai).
Million is [MIT-licensed](../../../LICENSE) open-source software and [research](https://arxiv.org/abs/2202.08409) by [Aiden Bai](https://aidenybai.com).
2 changes: 1 addition & 1 deletion packages/jsx-runtime/README.md
Expand Up @@ -4,4 +4,4 @@ Adds JSX support for [Million](https://github.com/aidenybai/million).

## License

Million is [MIT-licensed](../../../LICENSE) open-source software and [research](https://arxiv.org/abs/2202.08409) by [Aiden Bai](https://github.com/aidenybai).
Million is [MIT-licensed](../../../LICENSE) open-source software and [research](https://arxiv.org/abs/2202.08409) by [Aiden Bai](https://aidenybai.com).
2 changes: 1 addition & 1 deletion packages/million/README.md
Expand Up @@ -4,4 +4,4 @@ The core of [Million](https://github.com/aidenybai/million). Virtual DOM without

## License

Million is [MIT-licensed](../../../LICENSE) open-source software and [research](https://arxiv.org/abs/2202.08409) by [Aiden Bai](https://github.com/aidenybai).
Million is [MIT-licensed](../../../LICENSE) open-source software and [research](https://arxiv.org/abs/2202.08409) by [Aiden Bai](https://aidenybai.com).
2 changes: 1 addition & 1 deletion packages/shared/README.md
Expand Up @@ -4,4 +4,4 @@ Shared utility functions used by packages in Million.

## License

Million is [MIT-licensed](../../../LICENSE) open-source software and [research](https://arxiv.org/abs/2202.08409) by [Aiden Bai](https://github.com/aidenybai).
Million is [MIT-licensed](../../../LICENSE) open-source software and [research](https://arxiv.org/abs/2202.08409) by [Aiden Bai](https://aidenybai.com).
2 changes: 1 addition & 1 deletion packages/ssr/README.md
Expand Up @@ -4,4 +4,4 @@ Adds HMR support for [Million](https://github.com/aidenybai/million) for SSR.

## License

Million is [MIT-licensed](../../../LICENSE) open-source software and [research](https://arxiv.org/abs/2202.08409) by [Aiden Bai](https://github.com/aidenybai).
Million is [MIT-licensed](../../../LICENSE) open-source software and [research](https://arxiv.org/abs/2202.08409) by [Aiden Bai](https://aidenybai.com).
31 changes: 0 additions & 31 deletions paper/paper.bib

This file was deleted.

53 changes: 0 additions & 53 deletions paper/paper.md

This file was deleted.

34 changes: 17 additions & 17 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit ba3a768

Please sign in to comment.