Skip to content

Commit e198565

Browse files
committed
updated releases section
1 parent c9b650f commit e198565

2 files changed

Lines changed: 37 additions & 12 deletions

File tree

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ endif
2020
.PHONY: help
2121

2222
help: ## Print the help documentation
23-
@grep -E '^[a-zA-Z_-\]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
23+
@grep -E '^[a-zA-Z0-9_-\]+:.*?## .*$$' $(MAKEFILE_LIST) | sort | awk 'BEGIN {FS = ":.*?## "}; {printf "\033[36m%-30s\033[0m %s\n", $$1, $$2}'
2424

2525
#
2626
# Dependencies

README.md

Lines changed: 36 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# Description
66

7-
**go-simple-serializer** (aka GSS) is a simple library for serializing/deserializing objects that aims to decrease the burden on developers to support multiple serialization formats in their applications.
7+
**go-simple-serializer** (aka GSS) is a simple library for serializing/deserializing objects that aims to decrease the burden on developers to support multiple serialization formats in their applications. GSS supports a variety of operating systems, architectures, and use cases. A CLI is released for Microsoft Windows, Linux distributions, and [Darwin](https://en.wikipedia.org/wiki/Darwin_%28operating_system%29) platforms.
88

99
Using cross compilers, this library can also be called by other languages, including `C`, `C++`, `Python`, and `JavaScript`. This library is cross compiled into a Shared Object file (`*.so`), which can be called by `C`, `C++`, and `Python` on Linux machines. This library is also compiled to pure `JavaScript` using [GopherJS](https://github.com/gopherjs/gopherjs), which can be called by [Node.js](https://nodejs.org) and loaded in the browser. See the examples folder for patterns that you can use.
1010

@@ -14,17 +14,17 @@ GSS supports the following formats.
1414

1515
| Format | Description |
1616
| ---- | ------ |
17-
| bson | Binary JSON |
18-
| csv | Comma-Separated Values
17+
| bson | [Binary JSON](https://en.wikipedia.org/wiki/BSON) |
18+
| csv | [Comma-Separated Values](https://en.wikipedia.org/wiki/Comma-separated_values) |
1919
| hcl | HashiCorp Configuration Language |
2020
| hcl2 | HashiCorp Configuration Language (version 2.x) |
21-
| json | JSON |
22-
| jsonl | JSON Lines |
23-
| properties | Properties |
21+
| json | [JSON](http://json.org/) |
22+
| jsonl | [JSON Lines](http://jsonlines.org/) |
23+
| properties | [Properties](https://en.wikipedia.org/wiki/.properties) |
2424
| tags | single-line key=value tags |
25-
| toml | TOML |
25+
| toml | [TOML](https://github.com/toml-lang/toml) |
2626
| tsv | Tab-Separated Values |
27-
| yaml | YAML |
27+
| yaml | [YAML](https://yaml.org/) |
2828

2929
`hcl` and `hcl2` implementation is fragile and very much in `alpha`. The other formats are well-supported.
3030

@@ -81,10 +81,10 @@ See [go-simple-serializer](https://godoc.org/github.com/spatialcurrent/go-simple
8181
GSS is built as a module. In modern JavaScript, the module can be imported using [destructuring assignment](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring_assignment).
8282

8383
```javascript
84-
const { serialize, deserialize, convert, formats } = require('./dist/gss.global.min.js');
84+
const { serialize, deserialize, convert, formats } = require('./dist/gss.mod.min.js');
8585
```
8686

87-
In legacy JavaScript, you can use the `gss.main.js` file that simply adds `gss` to the global scope.
87+
In legacy JavaScript, you can use the `gss.global.js` file that simply adds `gss` to the global scope.
8888

8989
**Android**
9090

@@ -103,7 +103,30 @@ A variant of the `Convert` function is exported in a Shared Object file (`*.so`)
103103

104104
# Releases
105105

106-
**go-simple-serializer** is currently in **alpha**. See releases at https://github.com/spatialcurrent/go-simple-serializer/releases.
106+
**go-simple-serializer** is currently in **alpha**. See releases at https://github.com/spatialcurrent/go-simple-serializer/releases. See the **Building** section below to build from scratch.
107+
108+
**JavaScript**
109+
110+
- `gss.global.js`, `gss.global.js.map` - JavaScript global build with source map
111+
- `gss.global.min.js`, `gss.global.min.js.map` - Minified JavaScript global build with source map
112+
- `gss.mod.js`, `gss.mod.js.map` - JavaScript module build with source map
113+
- `gss.mod.min.js`, `gss.mod.min.js.map` - Minified JavaScript module with source map
114+
115+
**Darwin**
116+
117+
- `gss_darwin_amd64` - CLI for Darwin on amd64 (includes `macOS` and `iOS` platforms)
118+
119+
**Linux**
120+
121+
- `gss_linux_amd64` - CLI for Linux on amd64
122+
- `gss_linux_amd64` - CLI for Linux on arm64
123+
- `gss_linux_amd64.h`, `gss_linuxamd64.so` - Shared Object for Linux on amd64
124+
- `gss_linux_armv7.h`, `gss_linux_armv7.so` - Shared Object for Linux on ARMv7
125+
- `gss_linux_armv8.h`, `gss_linux_armv8.so` - Shared Object for Linux on ARMv8
126+
127+
**Windows**
128+
129+
- `gss_windows_amd64.exe` - CLI for Windows on amd64
107130

108131
# Examples
109132

@@ -149,6 +172,8 @@ See the `examples/js/index.js` file. You can run the example with `make run_exa
149172

150173
# Building
151174

175+
Use `make help` to see help information for each target.
176+
152177
**CLI**
153178

154179
The `make build_cli` script is used to build executables for Linux and Windows.

0 commit comments

Comments
 (0)