From c2962a668b0fa463b5c3a3b52bf3b49546faf358 Mon Sep 17 00:00:00 2001 From: Claire Kuang Date: Fri, 1 Nov 2024 17:42:31 +0000 Subject: [PATCH] Update README.md to align with main github page https://linear.app/speckle/issue/CNX-699/update-github-links-to-point-to-v3 --- README.md | 55 +++++++++++++++++++++++++++++++++++++++++-------------- 1 file changed, 41 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index 7de6c40f..013fcff7 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,42 @@ -# Core +

+
+ Speckle | Sharp | SDK +

-[![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%2Fdiscourse.speckle.works&style=flat-square&logo=discourse&logoColor=white)](https://discourse.speckle.works) [![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/) +

Twitter Follow Community forum users website docs

-[![codecov](https://codecov.io/gh/specklesystems/speckle-sharp-sdk/graph/badge.svg?token=TTM5OGr38m)](https://codecov.io/gh/specklesystems/speckle-sharp-sdk) +> Speckle is the first AEC data hub that connects with your favorite AEC tools. Speckle exists to overcome the challenges of working in a fragmented industry where communication, creative workflows, and the exchange of data are often hindered by siloed software and processes. It is here to make the industry better. -## **Disclaimer** +

+ .NET SDK, Tests, and Objects +

-This is an early alpha release, not meant for use in production! We're working to stabilise the 3.0 API, and until then there will be breaking changes. You have been warned! +

Codecov

-## Introduction +
-### Core +> [!WARNING] +> This is an early beta release, not meant for use in production! We're working to stabilise the 3.0 API, and until then there will be breaking changes. You have been warned! -Core is the .NET SDK for Speckle 3.0. It uses .NET Standard 2.0 and has been tested on Windows and MacOS. +# Repo structure + +This repo is the home of our next-generation Speckle .NET SDK. It uses .NET Standard 2.0 and has been tested on Windows and MacOS. + +- **SDK** + - [`Speckle.Sdk`](https://github.com/specklesystems/speckle-sharp-sdk/tree/dev/src/Speckle.Sdk): Transports, serialization, API wrappers, and logging. +- **Speckle Objects** + - [`Speckle.Objects`](https://github.com/specklesystems/speckle-sharp-sdk/tree/dev/src/Speckle.Objects): The Speckle Objects classes used for conversions. +- **Tests** + - [`Tests`](https://github.com/specklesystems/speckle-sharp-sdk/tree/dev/tests): Unit, serialization, integration, and performance tests. + +### Other repos + +Make sure to also check and ⭐️ these other Speckle next generation repositories: + +- [`speckle-sharp-connectors`](https://github.com/specklesystems/speckle-sharp-connectors): our csharp repo of next gen connectors +- [`speckle-sketchup`](https://github.com/specklesystems/speckle-sketchup): Sketchup connector +- [`speckle-powerbi`](https://github.com/specklesystems/speckle-powerbi): PowerBi connector +- and more [connectors & tooling](https://github.com/specklesystems/)! ## Documentation @@ -20,7 +44,7 @@ Comprehensive developer and user documentation can be found in our: ### 📚 [Speckle Docs website](https://speckle.guide/dev/) -## Developing & Debugging +# Developing and Debugging ### Building @@ -41,13 +65,16 @@ There are two test projects, one for unit tests and one for integration tests. T Before embarking on submitting a patch, please make sure you read: -- [Contribution Guidelines](CONTRIBUTING.md), +- [Contribution Guidelines](CONTRIBUTING.md) - [Code of Conduct](CODE_OF_CONDUCT.md) -## Community +# Security and Licensing + +### Security + +For any security vulnerabilities or concerns, please contact us directly at security[at]speckle.systems. -The Speckle Community hangs out on [the forum](https://discourse.speckle.works), do join and introduce yourself & feel free to ask us questions! +### License -## License +Unless otherwise described, the code in this repository is licensed under the Apache-2.0 License. Please note that some modules, extensions or code herein might be otherwise licensed. This is indicated either in the root of the containing folder under a different license file, or in the respective file's header. If you have any questions, don't hesitate to get in touch with us via [email](mailto:hello@speckle.systems). -Unless otherwise described, the code in this repository is licensed under the Apache-2.0 license.