Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
BGMP committed Oct 30, 2023
1 parent d189af9 commit acae17a
Showing 1 changed file with 7 additions and 6 deletions.
13 changes: 7 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,13 @@ RVA-Data

Static configuration data for [RVA](https://rva.lat/).

`models/` Contains all data stored in a `.csv` format. Modifying these files will reflect across all RVA's infrastructure.
`models/` Contains data stored in `.csv` files. Modifying these files will reflect across all RVA's infrastructure.

## Usage
For developers, the packaging pipeline was built using Rake. The following tasks take care of profiling and versioning
the files included in models.
- `:profile`: Profiles the data into `yml` and `yaml` format. If run locally, it should create directories with
extension-matching names at the project root.
- `:version`: Generates an `rva_points_data.json` file, which is later used by [RVA-Points](https://github.com/Re-Volt-America/RVA-Points)
For developers, the packaging pipeline was built using [Rake](https://ruby.github.io/rake/). The following tasks take
care of profiling and versioning the files included in models.

- `:profile`: Profiles the data into `yml` and `yaml` format. If run locally, it should create directories with
extension-matching names at the project root.
- `:version`: Generates an `rva_points_data.json` file, which is later used by [RVA-Points](https://github.com/Re-Volt-America/RVA-Points)
to detect car data updates.

0 comments on commit acae17a

Please sign in to comment.