@gouvfr-anct/timetable-to-osm-opening-hours/README.md

📚 Bibliothèque pour la transformation d'une série de plages horaires représentant un format emploi du temps vers le standard OSM pour les horaires d'ouverture.

# Timetable to OSM opening hours

## À propos

Bibliothèque pour la transformation d'une série de plages horaires représentant un format emploi du temps vers le standard OSM pour les horaires d'ouverture.  
Voir [la spécification OpenStreetMap opening hours](https://wiki.openstreetmap.org/wiki/Key:opening_hours/specification) pour en savoir plus au sujet de la syntaxe cible.

## Table of contents

- 🪧 [À propos](#à-propos)
- 🚀 [Installation](#installation)
- 🛠️ [Usage](#usage)
- 🤝 [Contribution](#contribution)
- 🏗️ [Built With](#built-with)
- 📝 [Licence](#licence)

## Installation

```bash
yarn add @gouvfr-anct/timetable-to-osm-opening-hours
```

## Usage

## Test usage

// Insert deploy with gitpod ?

####

## Contribution

To setup the project locally see the [contributing guide](CONTRIBUTING.md)

## Built With

### Langages & Frameworks

- [TypeScript](https://www.typescriptlang.org/) Strongly typed programming language that builds on JavaScript

### Tools

#### CLI

- [Jest](https://jestjs.io/) framework to run automated tests.
  - Configuration: [.tooling/.eslint/.eslintrc.cjs](.tooling/.eslint/.eslintrc.cjs)
- [Eslint](https://eslint.org/) Static code analyzer to find syntax problems.
  - Configuration: [.tooling/.eslint/.eslintrc.cjs](.tooling/.eslint/.eslintrc.cjs)
  - Local Documentation: [.tooling/.eslint/.eslintrc.cjs](.tooling/.eslint/.eslintrc.cjs)
- [Prettier](https://prettier.io/) Opinionated code formatter.
  - Configuration: [.tooling/.prettier/.prettierrc.cjs](.tooling/.prettier/.prettierrc.cjs)
- [Husky](https://typicode.github.io/husky/#/) Modern native git hooks. Used for quality check on commit and push.
  - Configuration: [.husky](.husky)
- [Commitlint](https://github.com/conventional-changelog/commitlint) checks if your commit messages meet the [conventional commit format](https://www.conventionalcommits.org/en/v1.0.0/).
  - Configuration: [.tooling/.commitlint/commitlint.config.cjs](.tooling/.commitlint/commitlint.config.cjs)
- [Lint-staged](https://github.com/okonet/lint-staged) execute commands on staged files.
  - Configuration: [.tooling/.lint-staged/.lintstagedrc](.tooling/.lintstaged/.lintstagedrc)

#### CI/CD

- [Github Actions](https://docs.github.com/en/actions)
- [Semantic release](https://github.com/semantic-release/semantic-release) Automates the whole package release workflow.
  - Configuration: [.tooling/.semantic-release/.semantic-release.config.cjs](.tooling/.semantic-release/.semantic-release.config.cjs)

## License

See the [LICENSE.md](LICENSE.md) file.