Skip to content
This repository has been archived by the owner on Aug 19, 2020. It is now read-only.

Commit

Permalink
Docs: Add temporary usage description to README (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
Alxandr committed Jun 1, 2017
1 parent 7e784a5 commit 0f3b319
Showing 1 changed file with 21 additions and 1 deletion.
22 changes: 21 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,24 @@
# Fable GitHub Client

[![Greenkeeper badge](https://badges.greenkeeper.io/YoloDev/Fable.Ava.svg)](https://greenkeeper.io/)
Stuff and things go here.

## Using
Currently there is no packages available for `Fable.Ava`, I'm waiting for some fixes to a dependent project first.
However, the fixes I'm waiting on has to do with building and versioning, and has nothing to do with the library itself,
so if you would like to try it out please feel free to do so :).

To try out `Fable.Ava` add the following to your `paket.dependencies`:

```
github YoloDev/Fable.Ava src/Fable.Ava/bindings.fs
github YoloDev/Fable.Ava src/Fable.Ava/assert.fs
github YoloDev/Fable.Ava src/Fable.Ava/spec.fs
```

Then add this to any `paket.references` where you want to import the files:

```
File: bindings.fs ava
File: assert.fs ava
File: spec.fs ava
```

0 comments on commit 0f3b319

Please sign in to comment.