Skip to content

Commit fe5ff5f

Browse files
committed
Update readme.markdown
1 parent ee091fb commit fe5ff5f

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

readme.markdown

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,8 +12,25 @@ Uses John Sheehan's excellent [RestSharp][3] [REST client][2] library for most o
1212
Barely does anything at the moment. I'm lazy. Started working on this off and on again. Send a pull request.
1313

1414
### Building
15-
For now, just fire up VS and hit build.
16-
To run the integration tests which require authentication, you'll need to create a file called csharp-github-api.IntegrationTests.dll.config. Simply use the provided example as a starting point. Just add your Github username and password. The file is in .gitignore, so you can't accidently commit it.
15+
To build, you will need to create a file called csharp-github-api.IntegrationTests.dll.config, in the csharp-github-api.IntegrationTests
16+
folder. Simply use the provided example as a starting point:
17+
18+
```
19+
$ cp csharp-github-api.IntegrationTests/csharp-github-api.IntegrationTests.dll.config.example csharp-github-api.IntegrationTests/csharp-github-api.Integration
20+
Tests.dll.config
21+
```
22+
23+
Just add your Github username and password. The file is in .gitignore, so you can't accidently commit it.
24+
```
25+
<?xml version="1.0" encoding="utf-8" ?>
26+
<configuration>
27+
<appSettings>
28+
<add key="username" value="example"/>
29+
<add key="password" value="password"/>
30+
<add key="token" value="abcedfg"/>
31+
</appSettings>
32+
</configuration>
33+
```
1734

1835
### License
1936
Licensed under the Apache License, Version 2.0, details included in the source.

0 commit comments

Comments
 (0)