Skip to content

Commit 2b136b6

Browse files
authored
Update README.md (#6286)
Added license description for 3'rd party licenses. Updated readme with list of current SDKs
1 parent 4bd9ce1 commit 2b136b6

File tree

2 files changed

+86
-25
lines changed

2 files changed

+86
-25
lines changed

README.md

+13-7
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,21 @@
11
![Realm](doc/logo.png)
22

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

55
This repository holds the source code for the core database component used by all the Realm Mobile Database products:
6+
7+
* [Realm C++](https://github.com/realm/realm-cpp)
8+
* [Realm Dart/Flutter](https://github.com/realm/realm-dart)
69
* [Realm Java](https://github.com/realm/realm-java)
7-
* [Realm Objective-C](https://github.com/realm/realm-cocoa)
8-
* [Realm React Native](https://github.com/realm/realm-js)
9-
* [Realm Swift](https://github.com/realm/realm-cocoa)
10+
* [Realm Kotlin](https://github.com/realm/realm-kotlin)
11+
* [Realm Swift/Objective-C](https://github.com/realm/realm-swift)
1012
* [Realm .NET](https://github.com/realm/realm-dotnet)
13+
* [Realm Node.js/React Native/Web](https://github.com/realm/realm-js)
1114

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

17+
Refer to the [Realm documentation](https://www.mongodb.com/docs/realm) for information about Realm and using the SDKs.
18+
1419
## Building Realm
1520

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

2833
## License
2934

30-
Realm Core is published under the Apache 2.0 license.
35+
Realm Core is published under the Apache 2.0 license.
3136

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

3439
## Feedback
3540

36-
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).
41+
Feedback to the Realm SDK's should be given in the respective SDK's github mentioned in the top of this readme.
42+
For anything specifically about Realm Core, please create an [issue here](https://github.com/realm/realm-core/issues/new).
3743

3844
<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">

THIRD-PARTY-NOTICES

+73-18
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@ Realm/MongoDB uses third-party libraries or other resources that may
22
be distributed under licenses different than the Realm software.
33

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

77
88

99
The attached notices are provided for information only.
1010

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

1414

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

1919
All rights reserved.
2020

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

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

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

4545

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

85+
86+
3) License Notice for JSON for Modern C++
87+
---------------------------------------------
88+
89+
MIT License
90+
91+
Copyright (c) 2013-2019 Niels Lohmann <http://nlohmann.me>.
92+
93+
Permission is hereby granted, free of charge, to any person obtaining a copy
94+
of this software and associated documentation files (the "Software"), to deal
95+
in the Software without restriction, including without limitation the rights
96+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
97+
copies of the Software, and to permit persons to whom the Software is
98+
furnished to do so, subject to the following conditions:
99+
100+
The above copyright notice and this permission notice shall be included in all
101+
copies or substantial portions of the Software.
102+
103+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
104+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
105+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
106+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
107+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
108+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
109+
SOFTWARE.
110+
111+
112+
4) License for MPark.Variant
113+
---------------------------------------------
114+
115+
Copyright Michael Park, 2015-2017
116+
117+
Boost Software License - Version 1.0 - August 17th, 2003
118+
119+
Permission is hereby granted, free of charge, to any person or organization
120+
obtaining a copy of the software and accompanying documentation covered by
121+
this license (the "Software") to use, reproduce, display, distribute,
122+
execute, and transmit the Software, and to prepare derivative works of the
123+
Software, and to permit third-parties to whom the Software is furnished to
124+
do so, all subject to the following:
125+
126+
The copyright notices in the Software and this entire statement, including
127+
the above license grant, this restriction and the following disclaimer,
128+
must be included in all copies of the Software, in whole or in part, and
129+
all derivative works of the Software, unless such copies or derivative
130+
works are solely in the form of machine-executable object code generated by
131+
a source language processor.
132+
133+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
134+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
135+
FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT
136+
SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE
137+
FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE,
138+
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
139+
DEALINGS IN THE SOFTWARE.

0 commit comments

Comments
 (0)