Merge pull request #7 from DorienHuijser/DorienEditReadme

Update readme

README.md

@@ -5,30 +5,37 @@
 
 [![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) [![crippled-filesystems](https://github.com/datalad/datalad-osf/workflows/crippled-filesystems/badge.svg)](https://github.com/datalad/datalad-osf/actions?query=workflow%3Acrippled-filesystems) [![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)
 
-Welcome! This repository contains a [DataLad](http://datalad.org) extension that equips DataLad with tools to interoperate with projects on the [Open Science Framework (OSF)](https://osf.io). Specifically, we attempt to create a git-annex special remote implementation to transform OSF storage into git-annex repositories. Files in OSF storage could thus be consumed or exported fast and easily via git-annex or datalad, and published to repository-hosting services (GitHub, GitLab, Bitbucket, ...) as lightweight repositories that constitute an alternative access to the data stored on the OSF - that is: you can git clone a repository from for example GitHub and get the data from the OSF from the command line or in your scripts.
+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.
 
 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
 
-- Datalad
-- Git
-- git-annex
-- Python 3
+- 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)
 
-## Install
+## Installation
 
 ```
-pip install [--user] .
+# 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
 ```
 
+## How to use
+
+See our **documentation** for some use cases on how to use this tool: http://docs.datalad.org/projects/osf/en/latest/
+
 ## How to contribute
 You are very welcome to help out developing this tool further. You can contribute by:
 
 - Creating an issue for bugs or tips for further development
 - 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.
+
 ## Contributors ✨
 
 Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):