mirror of
https://github.com/sbrow/ps.git
synced 2025-12-29 18:47:38 -05:00
Changed readme template
Updated documentation
This commit is contained in:
50
README.md
50
README.md
@@ -1,12 +1,54 @@
|
||||
# ps
|
||||
[](https://godoc.org/github.com/sbrow/ps) [](https://travis-ci.org/sbrow/ps) [](https://coveralls.io/github/sbrow/ps?branch=master) [](https://goreportcard.com/report/github.com/sbrow/ps)
|
||||
|
||||
Package ps is a rudimentary API between Adobe Photoshop CS5 and Golang. The
|
||||
interaction between the two is implemented using Javascript/VBScript.
|
||||
`import "github.com/sbrow/ps"`
|
||||
|
||||
* [Overview](#pkg-overview)
|
||||
* [Installation](pkg-installation)
|
||||
* [Subdirectories](#pkg-subdirectories)
|
||||
* [TODO](#pkg-note-TODO)
|
||||
* [Documentation](#pkg-doc)
|
||||
|
||||
## <a name="pkg-overview">Overview</a>
|
||||
Package ps is a rudimentary API between Adobe Photoshop CS5 and Golang.
|
||||
The interaction between the two is implemented using Javascript/VBScript.
|
||||
|
||||
Use it to control Photoshop, edit documents, and perform batch operations.
|
||||
|
||||
Currently only supports Photoshop CS5 Windows x86_64.
|
||||
|
||||
## Installation
|
||||
```bash
|
||||
|
||||
|
||||
|
||||
|
||||
## <a name="pkg-installation">Installation</a>
|
||||
```sh
|
||||
$ go get -u github.com/sbrow/ps
|
||||
```
|
||||
<!---
|
||||
|
||||
#### <a name="pkg-examples">Examples</a>
|
||||
* [JSLayer](example_JSLayer_test.go)
|
||||
|
||||
--->
|
||||
|
||||
|
||||
|
||||
## <a name="pkg-note-TODO">TODO</a>
|
||||
|
||||
`sbrow:` (2) Make TextLayer a subclass of ArtLayer.
|
||||
|
||||
`sbrow:` Reduce cylcomatic complexity
|
||||
|
||||
`sbrow:` Does funky things when passed invalid layername.
|
||||
|
||||
`sbrow:` Move to Document
|
||||
|
||||
`sbrow:` get rid of the semicolon.
|
||||
|
||||
## <a name="pkg-doc">Documentation</a>
|
||||
For full Documentation please visit https://godoc.org/github.com/sbrow/ps
|
||||
- - -
|
||||
|
||||
|
||||
Generated by [godoc2md](http://godoc.org/github.com/davecheney/godoc2md)
|
||||
|
||||
Reference in New Issue
Block a user