Merge branch 'master' of github.com:datalad/datalad-osf

README.md

@@ -1,32 +1,33 @@
-# DataLad extension for working with the Open Science Framework
+# DataLad-OSF: Opening up the Open Science Framework for DataLad 
 <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
 [![All Contributors](https://img.shields.io/badge/all_contributors-10-orange.svg?style=flat-square)](#contributors-)
 <!-- ALL-CONTRIBUTORS-BADGE:END -->
 
 [![GitHub release](https://img.shields.io/github/release/datalad/datalad-osf.svg)](https://GitHub.com/datalad/datalad-osf/releases/) [![PyPI version fury.io](https://badge.fury.io/py/datalad-osf.svg)](https://pypi.python.org/pypi/datalad-osf/) [![Travis tests status](https://secure.travis-ci.org/datalad/datalad-osf.png?branch=master)](https://travis-ci.org/datalad/datalad-osf) [![codecov.io](https://codecov.io/github/datalad/datalad-osf/coverage.svg?branch=master)](https://codecov.io/github/datalad/datalad-osf?branch=master) [![win2019](https://github.com/datalad/datalad-osf/workflows/win2019/badge.svg)](https://github.com/datalad/datalad-osf/actions?query=workflow%3Awin2019)  [![docs](https://github.com/datalad/datalad-osf/workflows/docs/badge.svg)](https://github.com/datalad/datalad-osf/actions?query=workflow%3Adocs) [![Documentation Status](https://readthedocs.org/projects/datalad-osf/badge/?version=latest)](http://docs.datalad.org/projects/osf/en/latest/?badge=latest) [![DOI](https://zenodo.org/badge/272689400.svg)](https://zenodo.org/badge/latestdoi/272689400)
 
 
-Welcome! This repository contains a [DataLad](http://datalad.org) extension that enables DataLad to work with the Open Science Framework (OSF). Use it to publish your data to an OSF project, using the OSF for dataset storage and sharing. This is established by transforming storage on the Open Science Framework (OSF) into a [git-annex](https://git-annex.branchable.com/) repository.
+Welcome! This repository contains a [DataLad](http://datalad.org) extension that enables DataLad to work with the Open Science Framework (OSF). Use it to share, retrieve and collaborate on DataLad datasets via the OSF.
 
 The development of this tool started at [OHBM Brainhack 2020](https://github.com/ohbm/hackathon2020/issues/156) in June 2020, coordinated in [this repository](https://github.com/adswa/git-annex-remote-osf). See our [documentation](http://docs.datalad.org/projects/osf) for more extensive information.
 
-## Required software
+## Requirements
 
 - Datalad: relies on [git-annex](http://docs.datalad.org/projects/osf/en/latest/git-annex.branchable.com/), [Git](http://docs.datalad.org/projects/osf/en/latest/git-scm.com/) and Python. If you don’t have DataLad installed yet, please follow the instructions [here](http://handbook.datalad.org/en/latest/intro/installation.html).
 - Account on the [Open Science Framework (OSF)](https://osf.io/register)
 
 ## Installation
 
 ```
-# once packed up for Pypi:
-pip install datalad-osf
-# in the meantime:
-pip install -e [--user] git+https://github.com/datalad/datalad-osf#egg=datalad-osf
+# create and enter a new virtual environment (optional)
+$ virtualenv --python=python3 ~/env/dl-osf
+$ . ~/env/dl-osf/bin/activate
+# install from PyPi
+$ pip install datalad-osf
 ```
 
 ## How to use
 
-See our **documentation** for some use cases on how to use this tool: http://docs.datalad.org/projects/osf/en/latest/
+See our [documentation](http://docs.datalad.org/projects/osf/) for more info on how to use this tool and a tutorial on major use cases.
 
 ## How to contribute
 You are very welcome to help out developing this tool further. You can contribute by:
@@ -35,7 +36,7 @@ You are very welcome to help out developing this tool further. You can contribut
 - Making a pull request for any changes suggested by yourself
 - Testing out the software and communicating your feedback to us
 
-See our contributing guidelines for more information.
+Please see our contributing guidelines for more information.
 
 ## Contributors ✨