Skip to content

Commit

Permalink
Update README.md (#6286)
Browse files Browse the repository at this point in the history
Added license description for 3'rd party licenses.
Updated readme with list of current SDKs
  • Loading branch information
ianpward authored Mar 22, 2023
1 parent 4bd9ce1 commit 2b136b6
Show file tree
Hide file tree
Showing 2 changed files with 86 additions and 25 deletions.
20 changes: 13 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,21 @@
![Realm](doc/logo.png)

Realm is a mobile database that runs directly inside phones, tablets or wearables - check out [realm.io](https://realm.io).
Realm is a mobile database that runs directly inside phones, tablets or wearables - check out [realm.io](https://realm.io).

This repository holds the source code for the core database component used by all the Realm Mobile Database products:

* [Realm C++](https://github.com/realm/realm-cpp)
* [Realm Dart/Flutter](https://github.com/realm/realm-dart)
* [Realm Java](https://github.com/realm/realm-java)
* [Realm Objective-C](https://github.com/realm/realm-cocoa)
* [Realm React Native](https://github.com/realm/realm-js)
* [Realm Swift](https://github.com/realm/realm-cocoa)
* [Realm Kotlin](https://github.com/realm/realm-kotlin)
* [Realm Swift/Objective-C](https://github.com/realm/realm-swift)
* [Realm .NET](https://github.com/realm/realm-dotnet)
* [Realm Node.js/React Native/Web](https://github.com/realm/realm-js)

Realm Core is not in itself an "end-user" product with a publicly stable and supported API.

Refer to the [Realm documentation](https://www.mongodb.com/docs/realm) for information about Realm and using the SDKs.

## Building Realm

How to build Realm Core is described [here](how-to-build.md).
Expand All @@ -27,12 +32,13 @@ unacceptable behavior to [[email protected]](mailto:community-conduc

## License

Realm Core is published under the Apache 2.0 license.
Realm Core is published under the Apache 2.0 license.

Please also see THIRD-PARTY-NOTICES for and licenses related to included third party libraries.
See the THIRD-PARTY-NOTICES file for licenses related to included third party libraries.

## Feedback

Feedback to the Realm SDK's should be given in the respective SDK's github mentioned in the top of this readme. Anything else about the Realm Core, please create an [issue here](https://github.com/realm/realm-core/issues/new).
Feedback to the Realm SDK's should be given in the respective SDK's github mentioned in the top of this readme.
For anything specifically about Realm Core, please create an [issue here](https://github.com/realm/realm-core/issues/new).

<img style="width: 0px; height: 0px;" src="https://3eaz4mshcd.execute-api.us-east-1.amazonaws.com/prod?s=https://github.com/realm/realm-core#README.md">
91 changes: 73 additions & 18 deletions THIRD-PARTY-NOTICES
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,14 @@ Realm/MongoDB uses third-party libraries or other resources that may
be distributed under licenses different than the Realm software.

In the event that we accidentally failed to list a required notice,
please bring it to our attention through any of the ways detailed here :
please bring it to our attention through any of the ways detailed here:

[email protected]

The attached notices are provided for information only.

For any licenses that require disclosure of source, sources are available at
https://github.com/realm/realm-core/src/external.
For any licenses that require disclosure of source, sources are available in the
realm-core/src/external/ directory


1) License Notice for IntelRDFPMathLib20U2
Expand All @@ -18,28 +18,28 @@ Copyright (c) 2018, Intel Corp.

All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
his list of conditions and the following disclaimer in the documentation
* Redistributions in binary form must reproduce the above copyright notice,
his list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of Intel Corporation nor the names of its contributors
may be used to endorse or promote products derived from this software
* Neither the name of Intel Corporation nor the names of its contributors
may be used to endorse or promote products derived from this software
without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED.
IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


Expand Down Expand Up @@ -82,3 +82,58 @@ DO NOT RELY ON FEATURES THAT ARE NOT DOCUMENTED in the manual,
especially those whose name start with YY_ or yy_. They are
private implementation details that can be changed or removed.


3) License Notice for JSON for Modern C++
---------------------------------------------

MIT License

Copyright (c) 2013-2019 Niels Lohmann <http://nlohmann.me>.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.


4) License for MPark.Variant
---------------------------------------------

Copyright Michael Park, 2015-2017

Boost Software License - Version 1.0 - August 17th, 2003

Permission is hereby granted, free of charge, to any person or organization
obtaining a copy of the software and accompanying documentation covered by
this license (the "Software") to use, reproduce, display, distribute,
execute, and transmit the Software, and to prepare derivative works of the
Software, and to permit third-parties to whom the Software is furnished to
do so, all subject to the following:

The copyright notices in the Software and this entire statement, including
the above license grant, this restriction and the following disclaimer,
must be included in all copies of the Software, in whole or in part, and
all derivative works of the Software, unless such copies or derivative
works are solely in the form of machine-executable object code generated by
a source language processor.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

0 comments on commit 2b136b6

Please sign in to comment.