Skip to content

Commit 04e05ee

Browse files
authored
Merge pull request #48 from znicholls/patch-1
Update README.md
2 parents e11ffbf + e6a2f20 commit 04e05ee

File tree

1 file changed

+4
-5
lines changed

1 file changed

+4
-5
lines changed

README.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,15 +18,15 @@ You can then enable the serverextension
1818
# What is it?
1919

2020
nbgitpuller allows you to construct a URL that points to a remote git repository.
21-
When it is clicked, nbgitpuller will pull for the contents of this repository
21+
When it is clicked, nbgitpuller will pull the contents of this repository
2222
into the user's current folder within Jupyter, while rendering a nice status page.
2323
This is especially useful when running on a JupyterHub, since it allows easy distribution
2424
of materials to users without requiring them to understand git.
2525

2626
# Merging behavior
2727

2828
When a link is clicked, we try to make opinionated intelligent guesses on how to
29-
do a merge automatically, without making the user have to do a conflict resolution.
29+
do a merge automatically, without making the user do a conflict resolution.
3030
nbgitpuller is designed to be used by folks who do not know that git is being used
3131
underneath, and are only pulling content one way from a source and modifying it -
3232
not pushing it back.
@@ -72,12 +72,11 @@ myjupyterhub.org/hub/user-redirect/git-pull?repo=<your-repo-url>&branch=<your-br
7272
This parameter is optional and defaults to `master`.
7373
- **subPath** is the path of the directory / notebook inside the repo to launch after cloning.
7474
This parameter is optional, and defaults to opening the base directory of the linked Git repository.
75-
- **app** is the branch name to use when cloning from the repository.
76-
This parameter is optional and defaults to either the environment variable
75+
- **app** This parameter is optional and defaults to either the environment variable
7776
`NBGITPULLER_APP`'s value or `notebook` if it is undefined. The allowed values
7877
are `lab` and `notebook`, the value will determine in what application view
7978
you end up in.
80-
- **urlPath** will if specified override `app` and `subPath` and redirect
79+
- **urlPath** will, if specified, override `app` and `subPath` and redirect
8180
blindly to the specified path.
8281

8382
# Local development

0 commit comments

Comments
 (0)