Skip to content

Commit

Permalink
Updating readme and changelog for 0.2.0
Browse files Browse the repository at this point in the history
  • Loading branch information
dareid committed Feb 8, 2016
1 parent 6db2a64 commit 68df2ca
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 4 deletions.
7 changes: 7 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,10 @@
0.2.0
- Added variable assignment [beta] (thanks @qingdimeng)
- Fixed boolean array parsing in lists (thanks @harryrose)
- Fixed long text response parsing
- Improved list parsing
- Added support for complex numbers and raw responses

0.1.0
- Added support for authentication
- Added support for booleans and integer values and arrays
Expand Down
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ func main() {
```
### Response Type Support

Roger currently supports the following response types:
Roger currently supports the following response types from R:

- string and string arrays
- booleans and boolean arrays
Expand All @@ -52,10 +52,21 @@ Roger currently supports the following response types:
- lists
- raw byte arrays

With the use of JSON, this capability can be used to transfer any serializable object.
With the use of JSON, this capability can be used to transfer any serializable object. For examples see sexp_parsing_test.go.


##Setup
### Assignment Support (beta)

Roger allows variables to be defined within an R session from Go. Currently the following types are supported for variable assignment:

- string and string arrays
- byte arrays
- double arrays
- int arrays

For examples see assignment_test.go.

## Setup
Rserve should be installed and started from R:

```R
Expand All @@ -80,7 +91,7 @@ Install Roger using:
go get github.com/senseyeio/roger
```

##Testing
## Testing
To ensure the library functions correctly, the end to end functionality must be tested. This is achieved using [Docker](https://docs.docker.com) and [Docker Compose](https://docs.docker.com/compose). To run tests, ensure you have both Docker and Docker Compose installed, then run `docker-compose build && docker-compose up -d` from within the test directory. This command will build and start a docker container containing multiple RServe servers. These servers will be utilized when running `go test` from the project's base directory. To stop the docker container call `docker-compose stop` from the test directory.

## Contributing
Expand Down

0 comments on commit 68df2ca

Please sign in to comment.