Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP

Loading…

Added script usage to `README.md` #6

Merged
merged 1 commit into from

2 participants

@IQAndreas

Added description on how to use the script (as it annoyed me a tad at first) and an example script (which may be superfluous)

@IQAndreas IQAndreas Added script usage to `README.md`
Added description on how to use the script (as it annoyed me a tad at first) and an example script (which may be superfluous)
cb15e76
@wereHamster wereHamster merged commit d8725e0 into wereHamster:master
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Commits on Jul 3, 2012
  1. @IQAndreas

    Added script usage to `README.md`

    IQAndreas authored
    Added description on how to use the script (as it annoyed me a tad at first) and an example script (which may be superfluous)
This page is out of date. Refresh to see the latest.
Showing with 12 additions and 1 deletion.
  1. +12 −1 README.md
View
13 README.md
@@ -1,5 +1,7 @@
This is a script which can upload files to github from the commandline.
+### Installation
+
First you need to get a oauth token:
curl -X POST -u <github user>:<github password> \
@@ -10,5 +12,14 @@ Copy the token from the response and put it into your git config file:
git config --global github.upload-script-token <the token from the response>
+### Usage
+
+ github-upload.rb <file-name> [<repository>]
+
+The `repository` parameter is optional. If one is not provided, if inside of a git repository, it will default to the remote named `origin`. If provided, the parameter should be in the format `<github user>/<repo>`.
+
+
+### Example
+
+ ./github-upload.rb bin/sample-app.jar wereHamster/ghup
-Now you can use this script.
Something went wrong with that request. Please try again.