# @hebcal/hebcal-rs

**This is still a work in progress and not everything is implemented.**

[![Build Status](https://github.com/hebcal/hebcal-rs/actions/workflows/rust.yml/badge.svg)](https://github.com/hebcal/hebcal-rs/actions/workflows/rust.yml)

This project is a Rust implementation of the Hebcal calendar. It is a perpetual calendar that can calculate the date of any Jewish holiday or festival, given a Gregorian date. The code is a fork of the [Hebcal for JS](https://github.com/hebcal/hebcal-es6/) project, which was written in JavaScript.

The project is currently in development, and the API is subject to change. However, the core functionality of calculating dates should be stable.

## Installation

To install the Hebcal Rust library, you can add it to your project's `Cargo.toml` file:

```toml
[dependencies]
hebcal = "0.1.0"
```

## Usage and API

- [ ] TBD

## Contributing

Contributions are welcome! If you have a suggestion for an improvement, please open an issue or create a pull request.

## License

This project is licensed under the terms of the [GNU General Public License v2.0](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html).

Copyright (C) 2024 Assaf Sapir

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

This program is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.

You should have received a copy of the GNU General Public License
along with this program. If not, see <https://www.gnu.org/licenses/>.