Skip to content

Commit be9f25d

Browse files
authored
Merge pull request #196 from ryansurf/feat-domain-name
updated arch
2 parents 988f932 + ada392e commit be9f25d

2 files changed

Lines changed: 9 additions & 2 deletions

File tree

README.md

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ Inspired by [wttr.in](https://github.com/chubin/wttr.in) · [Documentation](http
4242

4343
## 💻 Usage
4444

45-
There are two ways to use cli-surf: install it as a CLI tool via pipx, or run the server and access it via API/browser.
45+
There are several ways to use cli-surf: install it as a CLI tool via pipx, hit the public API, or run the server locally and access it via API/browser.
4646

4747
### Installing via [pipx](https://pipx.pypa.io/stable/) ([pypi](https://pypi.org/project/cli-surf/))
4848

@@ -56,7 +56,13 @@ surf --help
5656
surf --location scripps_pier --forecast 4
5757
```
5858

59-
### Running the server and using via API
59+
### Hitting the public API
60+
61+
```
62+
curl https://api.clisurf.com
63+
```
64+
65+
### Running the server locally and using via API
6066

6167
Start the server locally (see [Setup](#️-setup) below), then query it from your browser or CLI:
6268

@@ -330,6 +336,7 @@ GPT_PROMPT="What are some good places to eat around this surf spot?"
330336
| Optional frontend | Streamlit |
331337
| Packaging | Poetry, pipx |
332338
| Containerization | Docker / Docker Compose |
339+
| Cloud | AWS (Lambda, ECR, API Gateway), CloudFlare (DNS resolver), GoDaddy (register domain name) |
333340

334341
---
335342

docs/architecture.png

13.6 KB
Loading

0 commit comments

Comments
 (0)