elics/README.md

lightweight, flexible ECS for web games

# EliCS

[![CI](https://github.com/elixr-games/elics/workflows/CI/badge.svg)](https://github.com/elixr-games/elics/actions)
[![codecov](https://codecov.io/gh/elixr-games/elics/branch/main/graph/badge.svg)](https://codecov.io/gh/elixr-games/elics)
[![npm version](https://badge.fury.io/js/elics.svg)](https://badge.fury.io/js/elics)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

**EliCS** is a lightweight Entity Component System (ECS) framework optimized for complex 3D web applications. It offers **exceptional** performance while maintaining developer-friendly **ergonomics**, and provides the **flexibility** to accommodate different programming styles and architectural approaches.

## Documentation

For detailed information about using EliCS, including concepts, guides, and API references, please visit our [documentation site](https://elixr-games.github.io/elics/). Here are a few topics to get you started:

- [Getting Started](https://elixr-games.github.io/elics/getting-started.html)
- [API Reference](https://elixr-games.github.io/elics/architecture/overview.html)
- [Performance Benchmarks](https://elixr-games.github.io/elics/benchmarks.html)

## Contributing

Your contributions are welcome! Please read our [Contributing Guide](CONTRIBUTING.md) for development setup and guidelines, and make sure to review our [Code of Conduct](CODE_OF_CONDUCT.md) before contributing, thank you for being part of our community!

## Changelog

See [CHANGELOG.md](CHANGELOG.md) for version history and release notes.

## License

EliCS is created by [Felix Z](https://github.com/felixtrz). This project is licensed under the MIT License. For more details, see the [LICENSE](LICENSE) file in this repository.