Skip to content

Commit 68e29f3

Browse files
committed
Add note to README regarding PATs
1 parent e6db814 commit 68e29f3

File tree

2 files changed

+9
-3
lines changed

2 files changed

+9
-3
lines changed

README.Rmd

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,8 @@ remotes::install_github("centerforopenscience/osfr")
4040

4141
## Usage Examples
4242

43+
*Note: You need to [setup an OSF personal access token (PAT)][auth] to use osfr to manage projects or upload files.*
44+
4345
### Accessing Open Research Materials
4446

4547
Many researchers use OSF to archive and share their work. You can use osfr to explore publicly accessible projects and download the associated files---all you need to get started is the project's URL or GUID (global unique identifier).
@@ -83,7 +85,7 @@ We could continue this pattern of exploration and even download local copies of
8385

8486
### Managing Projects
8587

86-
You can use osfr to create projects, add sub-components, create directories, and upload files. See the [Getting Started vignette][getting-started] to learn more about building projects with osfr, but here is a quick example in which we:
88+
You can use osfr to create projects, add sub-components or directories, and upload files. See the [Getting Started vignette][getting-started] to learn more about building projects with osfr, but here is a quick example in which we:
8789

8890
1. Create a new project called *Motor Trend Car Road Tests*
8991
2. Create a sub-component called *Car Data*

README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,6 +38,10 @@ remotes::install_github("centerforopenscience/osfr")
3838

3939
## Usage Examples
4040

41+
*Note: You need to [setup an OSF personal access token
42+
(PAT)](http://centerforopenscience.github.io/osfr/articles/auth.html) to
43+
use osfr to manage projects or upload files.*
44+
4145
### Accessing Open Research Materials
4246

4347
Many researchers use OSF to archive and share their work. You can use
@@ -124,8 +128,8 @@ copies of project files using `osf_download()`.
124128

125129
### Managing Projects
126130

127-
You can use osfr to create projects, add sub-components, create
128-
directories, and upload files. See the [Getting Started
131+
You can use osfr to create projects, add sub-components or directories,
132+
and upload files. See the [Getting Started
129133
vignette](http://centerforopenscience.github.io/osfr/articles/getting_started.html)
130134
to learn more about building projects with osfr, but here is a quick
131135
example in which we:

0 commit comments

Comments
 (0)