Skip to content

Clarified usage steps in README #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
ofalvai wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Clarified usage steps in README #69

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
21 changes: 17 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ public interface ListColumns {
Then create a database that uses this column

```java
@Database(version = NotesDatabase.VERSION)
@Database(version = NotesDatabase.VERSION,
packageName = "net.simonvt.schematic.sample.provider")
public final class NotesDatabase {

public static final int VERSION = 1;
Expand All @@ -31,11 +32,12 @@ public final class NotesDatabase {
}
```


And finally define a ContentProvider
Then define a ContentProvider

```java
@ContentProvider(authority = NotesProvider.AUTHORITY, database = NotesDatabase.class)
@ContentProvider(authority = NotesProvider.AUTHORITY,
database = NotesDatabase.class,
packageName="net.simonvt.schematic.sample.provider")
public final class NotesProvider {

public static final String AUTHORITY = "net.simonvt.schematic.sample.NotesProvider";
Expand All @@ -50,6 +52,17 @@ public final class NotesProvider {
}
```

Then build the project to generate classes to a folder defined as `packageName` in annotations (or a `generated` subfolder by default).

Finally define the generated ContentProvider in AndroidManifest.xml.

```xml
<provider
android:authorities="net.simonvt.schematic.sample.NotesProvider"
android:name="net.simonvt.schematic.sample.provider.NotesProvider"
android:exported="false"/>
```

Table column annotations
------------------------

Expand Down