Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
* Remove initial notes on refactor
* Include more information about Encoding
  • Loading branch information
Francis committed Aug 14, 2015
1 parent 93bd72d commit 37a440f
Showing 1 changed file with 4 additions and 6 deletions.
10 changes: 4 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,15 @@
# ase
ASE decoder

Package for decoding ASE (Adobe Swatch Exchange) files into a struct.
Golang package for decoding and encoding ASE (Adobe Swatch Exchange) files.

The ASE specification can be found [here](http://www.selapa.net/swatches/colors/fileformats.php#adobe_ase).

Note: this was one of my first projects in Go as well as with binary decoding. It's in desperate need of a refactor. Will hopefully have time to make updates soon.

# Install

`$ go get github.com/arolek/ase`

# Getting started

the ASE package exposes a Decode method. You simply pass an io.Reader interface to ase.Decode and it will return an ASE struct of the decoded data. For example:
The ASE package exposes a Decode and Encode method. You simply pass an io.Reader interface to ase.Decode and it will return an ASE struct of the decoded data. For convenience, a DecodeFile method is available to decode an existing ASE file. For encoding, simply initialize an ASE struct and populate it with the appropriate Groups and Colors data.

## Examples

Expand Down Expand Up @@ -133,6 +129,8 @@ func main() {

// Create a new writer
w := bufio.NewWriter(f)

// Encode the ASE
ase.Encode(sampleAse, w)

// Use Flush to ensure all buffered operations have been
Expand Down

0 comments on commit 37a440f

Please sign in to comment.