Skip to content

Update README to note that this project is forking to also incorporat… #3

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

Merged
merged 1 commit into from
May 13, 2016
Merged

Update README to note that this project is forking to also incorporat… #3

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
20 changes: 14 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,15 @@
# A React Native wrapper for the Socket.io Swift Library
# A React Native wrapper for the Socket.io Library

This project was forked from Kirkness' React Native Swift Socket.Io project
[found here](https://github.com/kirkness/react-native-swift-socketio)

This project will be forked from Kirkness' project and so that it will
include the Java Swift Socket.Io project as well.

The wrapped 'Socket.IO-Client-Swift' can be [found here](https://github.com/socketio/socket.io-client-swift).

The wrapped 'Socket.IO-Client-Java' can be [found here](https://github.com/socketio/socket.io-client-java).

### Example
I've also added a super simple example app to /examples, copy and paste to your index.ios.js.
``` js
Expand Down Expand Up @@ -30,20 +38,20 @@ socket.onAny((event) => {
console.log(`${event.name} was called with data: `, event.items);
});

// Manually join namespace
socket.joinNamespace()
// Manually join namespace. Ex: namespace is now partyRoom
socket.joinNamespace('partyRoom')

// Leave namespace, back to '/'
socket.leaveNamespace()

// Emit an event to server
socket.emit('helloWorld', {some: 'data'});

// Optional boolean param 'fast' - defaults to false
socket.close(true);
//Disconnect from server
socket.disconnect();

// Reconnect to a closed socket
socket.reconect();
socket.reconnect();
```

### Constructor
Expand Down