-
Notifications
You must be signed in to change notification settings - Fork 1
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #154 from specklesystems/claire/cnx-699-update-git…
…hub-links-to-point-to-v3-1 Update README.md to align with main github page
- Loading branch information
Showing
1 changed file
with
41 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,26 +1,50 @@ | ||
| # Core | ||
| <h1 align="center"> | ||
| <img src="https://user-images.githubusercontent.com/2679513/131189167-18ea5fe1-c578-47f6-9785-3748178e4312.png" width="150px"/><br/> | ||
| Speckle | Sharp | SDK | ||
| </h1> | ||
|
|
||
| [](https://twitter.com/SpeckleSystems) [](https://discourse.speckle.works) [](https://speckle.systems) [](https://speckle.guide/dev/) | ||
| <p align="center"><a href="https://twitter.com/SpeckleSystems"><img src="https://img.shields.io/twitter/follow/SpeckleSystems?style=social" alt="Twitter Follow"></a> <a href="https://speckle.community"><img src="https://img.shields.io/discourse/users?server=https%3A%2F%2Fspeckle.community&style=flat-square&logo=discourse&logoColor=white" alt="Community forum users"></a> <a href="https://speckle.systems"><img src="https://img.shields.io/badge/https://-speckle.systems-royalblue?style=flat-square" alt="website"></a> <a href="https://speckle.guide/dev/"><img src="https://img.shields.io/badge/docs-speckle.guide-orange?style=flat-square&logo=read-the-docs&logoColor=white" alt="docs"></a></p> | ||
|
|
||
| [](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** | ||
| <h3 align="center"> | ||
| .NET SDK, Tests, and Objects | ||
| </h3> | ||
|
|
||
| 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! | ||
| <p align="center"><a href="https://codecov.io/gh/specklesystems/speckle-sharp-sdk"><img src="https://codecov.io/gh/specklesystems/speckle-sharp-sdk/graph/badge.svg?token=TTM5OGr38m" alt="Codecov"></a></p> | ||
|
|
||
| ## Introduction | ||
| <br/> | ||
|
|
||
| ### 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 | ||
|
|
||
| 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:[email protected]). | ||
|
|
||
| Unless otherwise described, the code in this repository is licensed under the Apache-2.0 license. | ||