diff --git a/packages/viewer/src/readme.md b/packages/viewer/src/readme.md deleted file mode 100644 index febbf5c87..000000000 --- a/packages/viewer/src/readme.md +++ /dev/null @@ -1,25 +0,0 @@ -# The Speckle Object Loader - -[![Twitter Follow](https://img.shields.io/twitter/follow/SpeckleSystems?style=social)](https://twitter.com/SpeckleSystems) [![Community forum users](https://img.shields.io/discourse/users?server=https%3A%2F%2Fspeckle.community&style=flat-square&logo=discourse&logoColor=white)](https://speckle.community) [![website](https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square)](https://speckle.systems) [![docs](https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white)](https://speckle.guide/dev/) - -## Documentation - -Comprehensive developer and user documentation can be found in our: - -#### 📚 [Speckle Docs website](https://speckle.guide/dev/) - -## Getting started - -This module is meant to simply help you stream objects from a Speckle Server by using the "efficient" download endpoint. - -It is currently used in [the 3d viewer](../viewer). Please check there for example usage! - -More details coming soon! - -## Community - -If in trouble, the Speckle Community hangs out on [the forum](https://speckle.community). Do join and introduce yourself! We're happy to help. - -## License - -Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. If you have any questions, don't hesitate to get in touch with us via [email](mailto:hello@speckle.systems).