Skip to content

Commit 7b45b89

Browse files
committed
Update ipieces README
1 parent e9640a1 commit 7b45b89

File tree

1 file changed

+12
-7
lines changed

1 file changed

+12
-7
lines changed

ipieces/README.md

+12-7
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,27 @@
11
# ipieces
22

3-
ipieces is a Go package used to create Geocaching puzzles such as [GCB1ZXB](https://coord.info/GCB1ZXB).
3+
ipieces is a Go package used to create Geocaching puzzles such as
4+
[GCB1ZXB](https://coord.info/GCB1ZXB).
45

56
## Documentation
67

78
Available at https://pkg.go.dev/github.com/bitlux/caches/ipieces.
89

910
## Deployment instructions
1011

11-
I deploy on [Google Cloud Run](https://cloud.google.com/run). To do that, you must first sign
12-
into the [Google Cloud console](https://console.cloud.google.com/),
13-
[create a project](https://cloud.google.com/resource-manager/docs/creating-managing-projects), and have
14-
[`gcloud`](https://cloud.google.com/sdk) installed.
12+
I deploy on [Google Cloud Run](https://cloud.google.com/run).
13+
https://cloud.google.com/run/docs/quickstarts/build-and-deploy/deploy-go-service is a good
14+
reference on how to us Google Cloud Run.
15+
16+
Create a directory for your project and put your code in a file named `main.go`. Run
17+
`go mod init <module name>` to create a module (because your `main.go` imports packages outside the
18+
standard library, Google Cloud Run requires it to be in its own module).
1519

1620
To deploy, `cd` to the directory with your `main.go` file and run:
1721
```
18-
gcloud run deploy --source . <project> [--allow-unauthenticated]
22+
gcloud run deploy --source . <service> [--allow-unauthenticated]
1923
```
24+
where `<service>` is any name you want.
2025

2126
## Testing
2227

@@ -29,4 +34,4 @@ where `<backdoor>` is the `Puzzle.Backdoor` string you set.
2934
## Contact / Support
3035

3136
I welcome issues and pull requests on GitHub and messages and email on
32-
[geocaching.com](https://www.geocaching.com/profile/?u=bitlux).
37+
[geocaching.com](https://www.geocaching.com/profile/?u=bitlux).

0 commit comments

Comments
 (0)