From f5009780aa5785266be4e4975163a1aa1b5245c0 Mon Sep 17 00:00:00 2001 From: Nikhil Vengal Date: Wed, 8 Oct 2025 09:36:23 -0700 Subject: [PATCH] Update readme --- README.md | 23 ++++++++++------------- 1 file changed, 10 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index b0f44dd..02ceff0 100644 --- a/README.md +++ b/README.md @@ -18,23 +18,20 @@ - You know this one; install dependencies 2. Set `NPS_API_KEY` using your tool of choice 3. `bin/rails db:prepare` - - This will create and load your database + - This will create and seed your database - hint: `tail -f log/development.log` to see what's going on 4. `bin/rails server` - Congrats you're ready to receive requests ``` -❯ curl 'localhost:3000/api/v1/parks?per_page=1' | jq '.' -[ - { - "id": 1, - "code": "abli", - "name": "Abraham Lincoln Birthplace", - "states": "KY", - "properties": {}, - "created_at": "2025-10-08T09:26:00.202Z", - "updated_at": "2025-10-08T09:26:00.202Z" +❯ curl 'localhost:3000/api/v1/stats' +{ + "park_count": 474, + "alert_count": 708, + "most_alerts": { + "park_code": "zion", + "alert_count": 6 } -] +} ``` ## Testing @@ -43,7 +40,7 @@ bin/rspec ``` -## TODO +## Notes - What additional cols to add to parks model? - Order results on index actions