From cb1101785abd95f7b4913aee123507d2cd068b05 Mon Sep 17 00:00:00 2001 From: Robert Long Date: Tue, 23 Jun 2020 15:50:44 -0700 Subject: [PATCH] Remove README.md from docs folder --- .gitignore | 1 + site/docs/README.md | 264 -------------------------------------------- 2 files changed, 1 insertion(+), 264 deletions(-) delete mode 100644 site/docs/README.md diff --git a/.gitignore b/.gitignore index 6f92097b..6ad9af19 100644 --- a/.gitignore +++ b/.gitignore @@ -2,6 +2,7 @@ lib build site/build/ +site/docs/README.md site/docs/api/ site/benchmarks/benchmarks.module.js benchmark_result.json diff --git a/site/docs/README.md b/site/docs/README.md deleted file mode 100644 index cce39e5c..00000000 --- a/site/docs/README.md +++ /dev/null @@ -1,264 +0,0 @@ -# ecsy - -[![NPM package][npm]][npm-url] -[![Build Size][build-size]][build-size-url] -[![Dev Dependencies][dev-dependencies]][dev-dependencies-url] -[![Build Status][build-status]][build-status-url] - - -ECSY (pronounced as "eck-see") is an highly experimental Entity Component System framework implemented in javascript, aiming to be lightweight, easy to use and with good performance. - -For detailed information on the architecture and API please visit the [documentation page](https://ecsy.io/docs/#/) - -* discourse forum: https://discourse.mozilla.org/c/mixed-reality/ecsy -* discord: https://discord.gg/cFnrQ2v - -## Features -- Framework agnostic -- Focused on providing a simple but yet efficient API -- Designed to avoid garbage collection as possible -- Systems, entities and components are scoped in a `world` instance -- Multiple queries per system -- Reactive support: - - Support for reactive behaviour on systems (React to changes on entities and components) - - System can query mutable or immutable components -- Predictable: - - Systems will run on the order they were registered or based on the priority defined when registering them - - Reactive events will not generate a random callback when emited but queued and be processed in order -- Modern Javascript: ES6, classes, modules,... -- Pool for components and entities - -# Examples -- Ball example: - - three.js: https://ecsy.io/examples/ball-example/three - - babylon: https://ecsy.io/examples/ball-example/babylon -- 2D Canvas https://ecsy.io/examples/canvas -- Factory pattern with `Not` operator: https://ecsy.io/examples/factory -- System state component example: https://ecsy.io/examples/systemstatecomponents - -# Usage - -Installing the package via `npm`: - -``` -npm install --save ecsy -``` - -```html - - - - Hello! - - - - - - - - - - - -``` -[Try it on glitch](https://glitch.com/~ecsy-boxes-and-circles) - - -You can also include the hosted javascript directly on your HTML: - -```html - - - - - -``` - -[npm]: https://img.shields.io/npm/v/ecsy.svg -[npm-url]: https://www.npmjs.com/package/ecsy -[build-size]: https://badgen.net/bundlephobia/minzip/ecsy -[build-size-url]: https://bundlephobia.com/result?p=ecsy -[dependencies]: https://img.shields.io/david/fernandojsg/ecsy.svg -[dependencies-url]: https://david-dm.org/fernandojsg/ecsy -[dev-dependencies]: https://img.shields.io/david/dev/fernandojsg/ecsy.svg -[dev-dependencies-url]: https://david-dm.org/fernandojsg/ecsy#info=devDependencies -[lgtm]: https://img.shields.io/lgtm/grade/javascript/g/fernandojsg/ecsy.svg?label=code%20quality -[lgtm-url]: https://lgtm.com/projects/g/fernandojsg/ecsy/ -[build-status]: https://travis-ci.com/fernandojsg/ecsy.svg?branch=master -[build-status-url]: https://travis-ci.com/fernandojsg/ecsy -