Skip to content

Commit

Permalink
docs(README.md): add beta disclaimer text
Browse files Browse the repository at this point in the history
A disclaimer outlining clearly that the repo is in beta so there is no false pretense
when people check out the repo thinking it's all finished.
  • Loading branch information
thestonefox committed Jul 15, 2019
1 parent 61c746b commit 9e7ea2c
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,10 @@
[![License][License-Badge]][License]
[![Backlog][Backlog-Badge]][Backlog]

## Beta Disclaimer

VRTK v4 has not yet been released fully is still in the beta phase meaning there may still be undiscovered bugs, missing features and a lack of usable documentation. All of these things are being worked on but progress is slow as there is only one person actively working on VRTK v4 in their spare time so please be patient and respectful. You are free to use VRTK v4 in any way you wish, but if you feel you will struggle figuring stuff out for yourself without detailed documentation then it may be better off if you wait until the full release of VRTK v4.

## Introduction

VRTK aims to make building spatial computing solutions in the [Unity] software fast and easy for beginners as well as experienced developers.
Expand Down Expand Up @@ -97,4 +101,4 @@ These materials are not sponsored by or affiliated with Unity Technologies or it
[VRTK.Academy]: https://academy.vrtk.io
[Videos]: http://videos.vrtk.io
[Twitter]: https://twitter.com/VR_Toolkit
[Backlog]: http://tracker.vrtk.io
[Backlog]: http://tracker.vrtk.io

0 comments on commit 9e7ea2c

Please sign in to comment.