![Tendigi Logo](assets/logo.png)
# Obsidian Embed

## Welcome
Obsidian Embed is a tool for generating iOS applications from static HTML sites, allowing you to produce fully-functional hybrid apps without Objective-C or Swift knowledge.

## Installation

To install Obsidian Ombed locally, run:

```
$ sudo npm install obsidian-embed -g
```

## Getting started

### Directory Setup


To get started, create a file called `config.json` in an empty directory.  A sample configuration might look like this:

```
{
	"product_name": "Fun App",
	"bundle_identifier": "com.tendigi.funApp",
	"icon": "assets/icon.png",
	"copy": ["html"]
}
```

in a directory with a structure that looks like this:

```
.
├── assets
│   └── icon.png
├── config.json
└── html
    ├── SecondPage.html
    └── index.html
```

### Configuration

Set the supported interface orientations by setting a `supportedInterfaceOrientations` variable to "landscape", "portrait", or "all" like this:

```
var supportedInterfaceOrientations = "landscape";
```

### Generating The App


To generate the Xcode project, run `$ obsidian-embed` in the directory with your assets and HTML files.  A pre-configured Xcode project will be generated for you in the `app` subdirectory.

For more information and available configuration options, run `$ obsidian-embed --help`


## Getting Help

Please direct all bugs, feature requests, and other concerns to Nick Lee, <nick@tendigi.com>

## License

Obsidian Embed is released under the MIT license. See LICENSE for details.