Skip to content

Commit 7130ae9

Browse files
author
jsdario
committed
Drafts README.md
1 parent 57a701f commit 7130ae9

File tree

3 files changed

+54
-0
lines changed

3 files changed

+54
-0
lines changed

CONTRIBUTORS.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
### Main contributors so far:
2+
3+
* Jesús Darío - [github](https://github.com/jsdario)
4+
* Fran Ríos - [github](https://github.com/franrios)
5+
* Pablo Pizarro - [github](https://github.com/pablopi)

LICENSE.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2016 Netbeast
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
# React Native Android Widget Proof Of Concept
2+
3+
Use React Native HeadlessJS to create background services that listen to Android Java Widget Providers (A Broadcast Receiver Service) :robot:
4+
5+
1. Create buttons in Java / Android XML to triggers intents
6+
2. Process these intents from the Javascript side with all the tools and flexibility
7+
from react-native.
8+
9+
It is a bit complicated, and we developed it with 0 knowledge from Android or Java, so I apologize if it feels bad designed. Please help us improve the strategy / code layout with Pull Requests.
10+
11+
### Try
12+
```bash
13+
git clone https://github.com/jsdario/react-native-android-widget-poc
14+
cd react-native-android-widget-poc
15+
npm install # or yarn install
16+
react-native run-android
17+
```
18+
19+
To build your own android widget start from this project as a widget and hack upon or replicate the strategy to make it work.
20+
21+
### How it works
22+
:construction: Needs to be filled
23+
24+
### Can I create widgets using React Native instead of Java?
25+
We haven't done this, but we belive that from this point has to be much easier,
26+
having the strategy laid down, we'd need to create [Native UI Components](https://facebook.github.io/react-native/docs/native-components-android.html)
27+
calling methods from the `RemoteView` class and context instead of the `View` class.
28+
It is not trivial to us, though.

0 commit comments

Comments
 (0)