Skip to content

Commit 9d398f8

Browse files
author
Vlad
committed
Update README.md and rename to rn-calendar-manager
1 parent 88d35f7 commit 9d398f8

File tree

2 files changed

+18
-19
lines changed

2 files changed

+18
-19
lines changed

README.md

Lines changed: 16 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
1-
# react-native-calendar-manager
1+
# rn-calendar-manager
22

3-
A calendar manager for React Native.
4-
Exposes `addEvent` method which can save an event to an Android or iOS device's native calendar app.
3+
*Note*
4+
We renamed the package from `react-native-calendar-manager` to `rn-calendar-manager` because the name was already taken on npm before we published.
5+
6+
A calendar manager for React Native. Exposes `addEvent` method which can save an event to an Android or iOS device's native calendar app.
57

68
## Supported React Native platforms
79

@@ -10,40 +12,37 @@ Exposes `addEvent` method which can save an event to an Android or iOS device's
1012

1113
## Plugin installation
1214

13-
Run `npm install --save git+ssh://git@bitbucket.org:fiveminutes/react-native-calendar-manager.git`
15+
Run `npm install --save rn-calendar-manager`
1416

1517
### Linking
1618

17-
Run:
18-
19-
`$ react-native link react-native-calendar-manager`
19+
If you're running React Native 0.60.0+, you're done, this module supports autolinking. If you're using React Native 0.59.10 and lower, check tag v1.0.7 instructions.
2020

21-
Which will link all native dependencies from the plugin, as well as add a directory containing your app's AppDelegate to CalendarManager projects build path which is necessary for building the iOS dependencies.
21+
Otherwise, check the manual linking section.
2222

23-
### Manual plugin linking
23+
### Manual linking
2424

2525
#### iOS
2626

27-
1. Open your project in XCode, right click on `Libraries` and click `Add
28-
Files to "Your Project Name"` Look under `node_modules/react-native-calendar-manager` and add `CalendarManager.xcodeproj`.
27+
1. Open your project in Xcode, right click on `Libraries` and click `Add
28+
Files to "Your Project Name"` Look under `node_modules/rn-calendar-manager` and add `CalendarManager.xcodeproj`.
2929
2. Add `libCalendarManager.a` to `Build Phases -> Link Binary With Libraries`
3030
3. Click on `CalendarManager.xcodeproj` in `Libraries` and go the `Build
3131
Settings` tab. Double click the text to the right of `Header Search
3232
Paths` and verify that it has the lines `$(SRCROOT)/../../node_modules/react-native/React/**` and `$(SRCROOT)/node_modules/react-native/React/**` - if it
33-
doesn't, then add them. This is so XCode is able to find the headers that
33+
doesn't, then add them. This is so Xcode is able to find the headers that
3434
the `CalendarManager` source files are referring to by pointing to the
3535
header files installed within the `react-native` `node_modules`
3636
directory.
37-
4. Add the line `$(SRCROOT)/../../ios/<YOUR PROJECT'S NAME>` as well, so that CalendarManager can find yor AppDelegate header file.
3837

3938
#### Android
4039

4140
1. in `android/settings.gradle`
4241
```
4342
#!groovy
4443
...
45-
include ':react-native-calendar-manager'
46-
project(':react-native-calendar-manager').projectDir = new File(rootProject.projectDir, '../node_modules/react-native-calendar-manager/android')
44+
include ':rn-calendar-manager'
45+
project(':rn-calendar-manager').projectDir = new File(rootProject.projectDir, '../node_modules/rn-calendar-manager/android')
4746
4847
```
4948

@@ -52,7 +51,7 @@ Which will link all native dependencies from the plugin, as well as add a direct
5251
#!groovy
5352
dependencies {
5453
...
55-
implementation project(':react-native-calendar-manager')
54+
implementation project(':rn-calendar-manager')
5655
}
5756
```
5857

@@ -77,7 +76,7 @@ Which will link all native dependencies from the plugin, as well as add a direct
7776

7877
## Example
7978
```javascript
80-
import CalendarManager from 'react-native-calendar-manager';
79+
import CalendarManager from 'rn-calendar-manager';
8180

8281
const inTenMinutes = Date.now() + 1000 * 60 * 10;
8382
const inTwentyMinutes = Date.now() + 1000 * 60 * 10 * 2;

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
2-
"name": "react-native-calendar-manager",
2+
"name": "rn-calendar-manager",
33
"version": "1.1.0",
44
"description": "A calendar manager for react-native",
55
"main": "index",
66
"repository": {
77
"type": "git",
8-
"url": "https://github.com/shoutem/react-native-calendar-manager"
8+
"url": "https://github.com/shoutem/rn-calendar-manager"
99
},
1010
"ios": {
1111
"project": "CalendarManager.xcodeproj"

0 commit comments

Comments
 (0)