Skip to content

Commit

Permalink
Update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
btbristow committed Jun 23, 2024
1 parent da82ed7 commit 9f7fbb2
Showing 1 changed file with 6 additions and 5 deletions.
11 changes: 6 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
# Bookstore Management API

With the Bookstore Management API, you can build custom inventory and order management apps for bookstores via three endpoints:
I designed this mock API and supporting documentation site for [Specialization in API Documentation](https://www.pce.uw.edu/specializations/api-documentation), which is offered by the University of Washington.

* `/books` - Books in the store inventory.
* `/customers` - Customers, who purchase books using orders.
* `/orders` - Orders from customers, made up of books.
In the scenario I came up with, developers use this API to build custom bookstore applications.

[Documentation](https://btbristow.github.io/book-tracker-api/) is in progress. To learn more about this API, contact your sales representative.
The Bookstore Management API is only designed to run with [JSON Server](https://www.npmjs.com/package/json-server).


My API docs are [located here](https://btbristow.github.io/bookstore-management-api/).

0 comments on commit 9f7fbb2

Please sign in to comment.