Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 2 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,6 @@ This repository holds the source code for the C++ SDK Preview.
* **Intuitive to Developers:** Realm’s object-oriented data model is simple to learn, doesn’t need an ORM, and lets you write less code.
* **Designed for Offline Use:** Realm’s local database persists data on-disk, so apps work as well offline as they do online.
* **Built for Mobile:** Realm is fully-featured, lightweight, and efficiently uses memory, disk space, and battery life.
* **[Device Sync](https://www.mongodb.com/docs/atlas/app-services/sync/)**: Makes it simple to keep data in sync across users, devices, and your backend in real-time. [Get started for free](https://www.mongodb.com/docs/realm/sdk/cpp/sync/) and [create the cloud backend](http://mongodb.com/realm/register?utm_medium=github_atlas_CTA&utm_source=realm_cpp_github).

## Object-Oriented: Streamline Your Code

Expand Down Expand Up @@ -109,9 +108,9 @@ realm.write([&cars](){

## Getting Started

See the detailed instructions in our [docs](https://www.mongodb.com/docs/atlas/device-sdks/sdk/cpp/).
See the detailed instructions in our [docs](docs/README.md).

The API reference is located [here](https://www.mongodb.com/docs/realm-sdks/cpp/latest/).
The `cpprealm` API reference docs can be generated locally using Doxygen.

## Installing Realm

Expand Down
41 changes: 41 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
# Realm SDK for C++
Use Realm SDK for C++ to write applications that access data
stored locally on devices.

## Get Started with the C++ SDK
These docs provide minimal-explanation code examples of how to work with the C++ SDK.
Use the SDK's open-source database - Realm - as an object store on the
device.

> **TIP:** See the [Quick Start](/docs/guides/quick-start.md) to integrate
> Realm into your project and get started.
>

### Install the C++ SDK
To get started, Swift Package Manager or Cmake to install the C++ SDK
in your project.

Include the header in the translation unit where you want to
use it to get started.

### Define an Object Schema
Use C++ to idiomatically define an object type.

### Open a Database
The SDK's database - Realm - stores objects in files on your device.
Configure and open a database
to get started reading and writing data.

### Read and Write Data
- Create, read, update, and delete objects from the database.
- Filter data using the SDK's query engine.

### React to Changes
Live objects mean that your data is always up-to-date.
You can register a notification handler
to watch for changes and perform some logic, such as updating
your UI.

## Recommended Reading
### C++ API Reference
Explore generated Doxygen reference docs for the C++ APIs.
9 changes: 9 additions & 0 deletions docs/guides/crud.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# CRUD - C++ SDK
Use the following pages to learn and reference CRUD operations:

- [Create](crud/create.md)
- [Read](crud/read.md)
- [Update](crud/update.md)
- [Delete](crud/delete.md)
- [Filter Data](crud/filter-data.md)
- [Threading](crud/threading.md)
Loading
Loading