Skip to content

Commit

Permalink
Tweak README
Browse files Browse the repository at this point in the history
  • Loading branch information
vcschapp committed Dec 21, 2023
1 parent 880e43c commit 3cdf59a
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 12 deletions.
9 changes: 4 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,8 +10,7 @@ performant binary encoding for geographic data based on

The most recent release is [v0.9.3-alpha](https://github.com/gogama/flatgeobuf/releases/tag/v0.9.3-alpha).

A beta release is expected by 2023-12-31. A stable v1.0.0 will be
released before 2024-01-31.
A stable v1.0.0 will be released by 2024-01-31.

## Getting Started

Expand All @@ -21,7 +20,7 @@ Get the code:
$ go get github.com/gogama/flatgeobuf
```

Read a Flatgeobuf file:
Read a Flatgeobuf file, search the index, _etc._:

```go
package getStartedReading
Expand All @@ -34,13 +33,13 @@ import (
func main() {
f, _ := os.Open("example.fgb")
r := flatgeobuf.NewFileReader(f)
// Use methods on FileReader 'r' to read header; read or search Index; or
// Use methods on FileReader 'r' to read header; read or search index; or
// read features. Use a PropReader to read feature properties.
// https://pkg.go.dev/github.com/gogama/flatgeobuf/flatgeobuf#FileReader
}
```

Write a Flatgeobuf file:
Write a Flatgeobuf file, create index of features, _etc._:

```go
package getStartedWriting
Expand Down
13 changes: 6 additions & 7 deletions TODO.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
NEXT STEPS:
1. Add GitHub action to build/test on commit? (If free.)
2. Cut v0.9.5-beta.
3. Update copyrights to 2024.
5. Clear out any remaining TODO, for e.g. example_test.go.
6. Finish README.md items:
1. Cut v0.9.5-beta.
2. Update copyrights to 2024.
3. Clear out any remaining TODO, for e.g. example_test.go.
4. Finish README.md items:
(a) Project Status.
7. Delete this TODO file.
8. Cut v1.0.0.
5. Delete this TODO file.
6. Cut v1.0.0.

Future directions:
1. Another interesting interaction system would be an Appender which
Expand Down

0 comments on commit 3cdf59a

Please sign in to comment.