Skip to content

Commit

Permalink
New README.md strategy
Browse files Browse the repository at this point in the history
* Move README.md into `packages/realm` and replace with a symbolic link.
* Update all relative paths in README.md to be absolute.
* Replace realm.io links
  • Loading branch information
takameyer committed Oct 5, 2023
1 parent ab2ee63 commit b312932
Show file tree
Hide file tree
Showing 18 changed files with 247 additions and 289 deletions.
230 changes: 0 additions & 230 deletions README.md

This file was deleted.

1 change: 1 addition & 0 deletions README.md
2 changes: 1 addition & 1 deletion examples/node-telemetry/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
"author": {
"name": "Realm",
"email": "help@realm.io",
"url": "https://realm.io"
"url": "https://www.mongodb.com/docs/realm/"
},
"license": "apache-2.0",
"dependencies": {
Expand Down
2 changes: 1 addition & 1 deletion integration-tests/environments/electron/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"author": {
"name": "Realm",
"email": "help@realm.io",
"url": "https://realm.io"
"url": "https://www.mongodb.com/docs/realm/"
},
"private": true,
"main": "app/main.js",
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"description": "Mono-repository root for the Realm JS SDK",
"private": true,
"license": "apache-2.0",
"homepage": "https://realm.io",
"homepage": "https://www.mongodb.com/docs/realm/",
"scripts": {
"build": "wireit",
"bundle": "wireit",
Expand Down Expand Up @@ -50,7 +50,7 @@
"author": {
"name": "Realm",
"email": "help@realm.io",
"url": "https://realm.io"
"url": "https://www.mongodb.com/docs/realm/"
},
"workspaces": [
"example",
Expand Down
2 changes: 1 addition & 1 deletion packages/babel-plugin/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"author": {
"name": "Realm",
"email": "help@realm.io",
"url": "https://realm.io"
"url": "https://www.mongodb.com/docs/realm/"
},
"license": "apache-2.0",
"devDependencies": {
Expand Down
2 changes: 1 addition & 1 deletion packages/mocha-reporter/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"author": {
"name": "Realm",
"email": "help@realm.io",
"url": "https://realm.io"
"url": "https://www.mongodb.com/docs/realm/"
},
"repository": {
"type": "git",
Expand Down
2 changes: 1 addition & 1 deletion packages/realm-app-importer/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
"author": {
"name": "Realm",
"email": "help@realm.io",
"url": "https://realm.io"
"url": "https://www.mongodb.com/docs/realm/"
},
"contributors": [
"Kræn Hansen <kraen.hansen@mongodb.com> (https://github.com/kraenhansen)"
Expand Down
2 changes: 1 addition & 1 deletion packages/realm-common/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
"author": {
"name": "Realm",
"email": "help@realm.io",
"url": "https://realm.io"
"url": "https://www.mongodb.com/docs/realm/"
},
"repository": {
"type": "git",
Expand Down
2 changes: 1 addition & 1 deletion packages/realm-network-transport/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"author": {
"name": "Realm",
"email": "help@realm.io",
"url": "https://realm.io"
"url": "https://www.mongodb.com/docs/realm/"
},
"repository": {
"type": "git",
Expand Down
4 changes: 2 additions & 2 deletions packages/realm-react/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -96,9 +96,9 @@
"hooks"
],
"author": {
"name": "Realm",
"name": "MongoDB",
"email": "help@realm.io",
"url": "https://realm.io"
"url": "https://www.mongodb.com/docs/realm/"
},
"repository": {
"type": "git",
Expand Down
2 changes: 1 addition & 1 deletion packages/realm-tools/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"author": {
"name": "Realm",
"email": "help@realm.io",
"url": "https://realm.io"
"url": "https://www.mongodb.com/docs/realm/"
},
"contributors": [
"Kenneth Geisshirt <kenneth.geisshirt@mongodb.com> (https://github.com/kneth)"
Expand Down
2 changes: 1 addition & 1 deletion packages/realm-web/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@
"author": {
"name": "Realm",
"email": "help@realm.io",
"url": "https://realm.io"
"url": "https://www.mongodb.com/docs/realm/"
},
"repository": {
"type": "git",
Expand Down
1 change: 0 additions & 1 deletion packages/realm/COMPATIBILITY.md

This file was deleted.

40 changes: 0 additions & 40 deletions packages/realm/CONTRIBUTING.md

This file was deleted.

1 change: 0 additions & 1 deletion packages/realm/README.md

This file was deleted.

Loading

0 comments on commit b312932

Please sign in to comment.