Skip to content

Commit

Permalink
Renaming README and fixed typo in gitignore
Browse files Browse the repository at this point in the history
  • Loading branch information
brandonvfx committed May 26, 2015
1 parent 2da8b27 commit e7b18a4
Show file tree
Hide file tree
Showing 2 changed files with 36 additions and 1 deletion.
2 changes: 1 addition & 1 deletion .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,6 @@ _testmain.go
.env

gin-bin
go-restful
sg-restful

Godeps/_workspace
35 changes: 35 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# SG Restful - WIP

## NOT PRODUCTION READY!

SG Restful is a restful interface for the [Shotgun](http://shotgunsoftware.com) Api.


## What works currently

### Entities

- Read
- Get by id
- Get all
- Returning fields
- Pagination
- Create
- Update
- Delete


## Auth

SG Restful using basic auth for getting script and user credentials. This may change in the future.

Script `Authorization` header:
```
Basic <base64 scipt_name:sript_key>
```

User `Authorization` header:
( I don't suggest using this unless you have an internal Shotgun sever. )
```
Basic-user <base64 user_name:user_password>
```

0 comments on commit e7b18a4

Please sign in to comment.