Skip to content

Commit 4ce1111

Browse files
committed
more doc tweaks
1 parent 8c39f98 commit 4ce1111

File tree

1 file changed

+14
-21
lines changed

1 file changed

+14
-21
lines changed

README.md

Lines changed: 14 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -5,24 +5,31 @@ pynux
55

66
python function library for working with nuxeo "REST" APIs.
77

8-
## Install / Upgrade
8+
## Install / Upgrade with `pip`
99

10-
latest release
10+
master branch can be installed with
1111

1212
```
1313
pip install https://github.com/ucldc/pynux/tarball/master --upgrade
1414
```
15+
We'll try to keep `master` stable, but for the latest release.
1516

16-
its possible you might need a latter day `pip`
17+
See https://github.com/ucldc/pynux/releases/latest , or this might work
1718

1819
```
19-
pip install --upgrade pip
20+
pip install $(curl -sL https://api.github.com/repos/ucldc/pynux/releases/latest | jq -r '.tarball_url')
2021
```
2122

23+
its possible you might need a latter day `pip`
24+
2225
```
23-
pip install git+git://github.com/ucldc/pynux.git
26+
pip install --upgrade pip
2427
```
25-
or
28+
29+
## install code
30+
31+
checkout code and install
32+
2633
```
2734
git clone https://github.com/ucldc/pynux.git
2835
cd pynux
@@ -34,20 +41,6 @@ python setup.py install
3441
python setup.py test
3542
```
3643

37-
## [Command and API Documentation](http://ucldc.github.io/pynux/)
38-
39-
## Requirements
40-
41-
### [Nuxeo](http://www.nuxeo.com/)
42-
43-
### REST API
44-
45-
* [docs.nuxeo.com](http://doc.nuxeo.com/display/public/NXDOC/REST+API)
46-
* [marketplace](https://connect.nuxeo.com/nuxeo/site/marketplace/package/nuxeo-rest-api)
47-
* `nuxeoctl mp-install nuxeo-rest-api`
48-
* [api viewer](http://doc.nuxeo.com/display/public/NXDOC/Resources+Endpoints)
49-
50-
5144
## Configuration
5245

5346
To configure pynux, you will need to create a file named `.pynuxrc`. You can use a simple text editor to create the file. In a Windows OS, the file should be placed in `C:\Users\Username\`. In a Mac OS, the file should be placed in `~/.pynuxrc` (open a terminal window and type `open .` for the correct location).
@@ -97,7 +90,7 @@ nxls.py / --show-custom-function foo
9790

9891
## License
9992

100-
Copyright © 2017, Regents of the University of California
93+
Copyright © 2019, Regents of the University of California
10194

10295
All rights reserved.
10396

0 commit comments

Comments
 (0)