status-im
/
re-natal
mirror of https://github.com/status-im/re-natal.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

Update package.json and README.md

This commit is contained in:
Artur Girenko 2015-11-20 20:07:09 +01:00
parent db91cb6ffc
commit 90120d2ff7
2 changed files with 27 additions and 31 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

43
README.md
View File

@ -1,12 +1,17 @@
# Natal
### Bootstrap ClojureScript-based React Native apps
# Re-Natal
### Bootstrap ClojureScript-based React Native apps with reagent and re-frame
[Dan Motzenbecker](http://oxism.com), MIT License
[@dcmotz](https://twitter.com/dcmotz)
[@dcmotz](https://twitter.com/dcmotz),
[@drapanjanas](https://twitter.com/drapanjanas)
---
Natal is a simple command-line utility that automates most of the process of
setting up a React Native app running on ClojureScript.
This project is a fork of [dmotz/natal](https://github.com/dmotz/natal) with
the goal of generating skeleton of native app for iOS and Android based on
[Reagent](https://github.com/reagent-project/reagent)and[re-frame](https://github.com/Day8/re-frame).
Re-Natal is a simple command-line utility that automates most of the process of
setting up a React Native app running on ClojureScript wit reagent an re-frame.
It stands firmly on the shoulders of giants, specifically those of
[Mike Fikes](http://blog.fikesfarm.com) who created
@ -14,6 +19,7 @@ It stands firmly on the shoulders of giants, specifically those of
[documentation](http://cljsrn.org/ambly.html)
on setting up a ClojureScript React Native app.
Generated project will work in iOS as well as on Android devices.
## Usage
@ -23,36 +29,27 @@ Before getting started, make sure you have the
Then, install the CLI using npm:
```
$ npm install -g natal
$ npm install -g re-natal
```
To bootstrap a new app, run `natal init` with your app's name as an argument:
To bootstrap a new app, run `re-natal init` with your app's name as an argument:
```
$ natal init FutureApp
$ re-natal init FutureApp
```
If your app's name is more than a single word, be sure to type it in CamelCase.
A corresponding hyphenated Clojure namespace will be created.
By default Natal will create a simple skeleton based on the current stable
version of [Om](http://omcljs.org) (aka Om Now). If you'd like to base your app
upon Om Next, you can specify a React interface template during init:
```
$ natal init FutureApp --interface om-next
```
Keep in mind your app isn't limited to the React interfaces Natal provides
templates for; these are just for convenience.
If all goes well your app should compile and boot in the simulator.
By default Natal will create a simple skeleton based on the current
version of [Reagent](https://github.com/reagent-project/reagent) and [Day8/re-frame](https://github.com/Day8/re-frame).
If all goes well your app should compile and boot in the iOS simulator.
From there you can begin an interactive workflow by starting the REPL.
```
$ cd future-app
$ natal repl
$ re-natal repl
```
If there are no issues, the REPL should connect to the simulator automatically.
@ -136,7 +133,3 @@ tools.
Contributions are welcome.
For more ClojureScript React Native resources visit [cljsrn.org](http://cljsrn.org).
If you're looking for a simple ClojureScript wrapper around the React Native API,
check out the companion library [Natal Shell](https://github.com/dmotz/natal-shell).
It is included by default in projects generated by Natal.

15
package.json
View File

@ -1,7 +1,7 @@
{
"name": "natal",
"name": "re-natal",
"version": "0.1.7",
"description": "Bootstrap ClojureScript React Native apps",
"description": "Bootstrap ClojureScript React Native apps with reagent and re-frame for iOS and Android",
"main": "index.js",
"author": {
"name": "Dan Motzenbecker",
@ -20,19 +20,22 @@
},
"repository": {
"type": "git",
"url": "git://github.com/dmotz/natal.git"
"url": "git://github.com/drapanjanas/re-natal.git"
},
"homepage": "http://github.com/dmotz/natal",
"homepage": "http://github.com/drapanjanas/re-natal.git",
"engine-strict": true,
"preferGlobal": true,
"bin": {
"natal": "./index.js"
"re-natal": "./index.js"
},
"keywords": [
"clojure",
"clojurescript",
"react",
"react native",
"ios"
"ios",
"android",
"reagent",
"re-frame"
]
}