refactor: expand name

This commit is contained in:
Wieland Schöbl
2021-08-05 16:16:48 +02:00
parent 4d1d69bd0c
commit 62b226653d

View File

@@ -1,4 +1,4 @@
# @openstapps/es-mapping-gen
# @openstapps/es-mapping-generator
[![pipeline status](https://img.shields.io/gitlab/pipeline/openstapps/es-mapping-gen.svg?style=flat-square)](https://gitlab.com/openstapps/es-mapping-gen/commits/master)
[![npm](https://img.shields.io/npm/v/@openstapps/es-mapping-gen.svg?style=flat-square)](https://npmjs.com/package/@openstapps/es-mapping-gen)
@@ -7,14 +7,14 @@
Tools to convert and validate StAppsCore
## What is ES Mapping Gen for?
## What is the ES Mapping Generator for?
The ES Mapping Gen is for converting TypeScript interfaces to Elasticsearch mappings,
The ES Mapping Generator is for converting TypeScript interfaces to Elasticsearch mappings,
with support for Integer and Float types, Dates, etc.
## Why is this a separate package?
The ES Mapping Gen relies on an outdated version of TypeDoc, that can't be updated.
The ES Mapping Generator relies on an outdated version of TypeDoc, that can't be updated.
Because of that, it then also relies on an outdated version of TypeScript, resulting
in a cascade effect things that can't be updated. Because of that, we decided to isolate
it to the best of our abilities.