diff --git a/LICENSE b/LICENSE index 241281b..d72c834 100644 --- a/LICENSE +++ b/LICENSE @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2021 Aiden Bai +Copyright (c) 2021-present Aiden Bai Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 1a25c3d..35d4d18 100644 --- a/README.md +++ b/README.md @@ -1,31 +1,33 @@ -# 🪶 `tiny-vdom` +# 💯 Hundred ### Hyper-lightweight Virtual DOM -`tiny-vdom` is intended to be the most lightweight virtual DOM implementation, and is a proof-of-concept and a learning resource more than a tool you should actually use in production. +`hundred` is intended to be the most lightweight virtual DOM implementation, and is a proof-of-concept and a learning resource more than a tool you should actually use in production. -Additionally, just because `tiny-vdom` is lightweight doesn't mean it's performant by any means. It is faster and smaller than [`simple-virtual-dom`](https://github.com/livoras/simple-virtual-dom), but ranks behind [production-ready Virtual DOM libraries](https://million.js.org/benchmarks/official-benchmarks) +Additionally, just because `hundred` is lightweight doesn't mean it's performant by any means. It is faster and smaller than [`simple-virtual-dom`](https://github.com/livoras/simple-virtual-dom), but ranks behind [production-ready Virtual DOM libraries](https://million.js.org/benchmarks/official-benchmarks) > Note: If you're looking for something a bit more comprehensive, check out [Million](https://github.com/aidenybai/million) ## Installation ```sh -npm install tiny-vdom +npm install hundred ``` ## Usage -`index.js` - ```js -import { h, createElement, patch } from 'tiny-vdom'; +import { h, createElement, patch } from 'hundred'; const el = createElement(h('div')); patch(el, h('div', null, 'Hello World!'), h('div')); ``` +`patch()` function has a standard interface that is used in many Virtual DOM libraries. First argument is a DOM node that will be used as the live DOM reference, and the second one is a Virtual DOM to render. + +`h()` function will instantiate a "Virtual DOM" node for an element. + ## License -`tiny-vdom` is [MIT-licensed](LICENSE) open-source software by [Aiden Bai](https://github.com/aidenybai). +`hundred` is [MIT-licensed](LICENSE) open-source software by [Aiden Bai](https://github.com/aidenybai). diff --git a/package.json b/package.json index a23725b..24ab728 100644 --- a/package.json +++ b/package.json @@ -1,5 +1,5 @@ { - "name": "tiny-vdom", + "name": "hundred", "version": "0.0.3", "description": "🤏 Smallest possible virtual DOM implementation", "main": "dist/index.js", @@ -11,14 +11,14 @@ }, "repository": { "type": "git", - "url": "git+https://github.com/aidenybai/tiny-vdom.git" + "url": "git+https://github.com/aidenybai/hundred.git" }, "author": "", "license": "MIT", "bugs": { - "url": "https://github.com/aidenybai/tiny-vdom/issues" + "url": "https://github.com/aidenybai/hundred/issues" }, - "homepage": "https://github.com/aidenybai/tiny-vdom#readme", + "homepage": "https://github.com/aidenybai/hundred#readme", "devDependencies": { "tsup": "^5.11.13", "typescript": "^4.5.5"