Skip to content

Commit

Permalink
Clarifying references to TRAMS in README document (#530)
Browse files Browse the repository at this point in the history
Updating and clarifying references to TRAMS in project documentation.
  • Loading branch information
thill-dxw authored Jul 5, 2024
1 parent e61427d commit 4bdc808
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
# trams-data-api
Simple api for getting data from the TRAMS system
# academies-api
Simple api for getting data from the central Academies Database datastore.

NB: Historically this API was used to support the operations of the legacy TRAMS application, and references in legacy documentation will at times refer to it as the 'TRAMS API', etc.. This usage is entirely historical, however, and is now deprecated.

## Development Setup

Expand Down Expand Up @@ -99,4 +101,4 @@ If injected through the environment, use `ApiKeys__x` naming conventions for the

The current census .csv file can be found a `TramsDataApi/CensusData/`

If you need to replace this file with a newer one then add the new file to the `TramsDataApi/CensusData/` folder and then update the `CensusDataGateway.cs` file to reflect the new filename.
If you need to replace this file with a newer one then add the new file to the `TramsDataApi/CensusData/` folder and then update the `CensusDataGateway.cs` file to reflect the new filename.

0 comments on commit 4bdc808

Please sign in to comment.