Minor tweaks to README and documentation.

- Added link to documentation page on README. - Updated documentation with info how to add the library.
defold · Jan 25, 2019 · 851b3aa · 851b3aa
1 parent 6b67125
commit 851b3aa
Show file tree

Hide file tree

Showing 5 changed files with 16 additions and 9 deletions.
diff --git a/README.md b/README.md
@@ -1 +1,5 @@
 # extension-webview
+
+Functions for creating and controlling webviews to show HTML pages or evaluate JavaScript. These API:s only exist on mobile platforms.
+
+Documentation and usage information can be found at: [https://defold.github.io/extension-webview/](https://defold.github.io/extension-webview/)
diff --git a/docs/_config.yml b/docs/_config.yml
@@ -1,3 +1 @@
 title: "extension-webview"
-description: "Defold extension for creating and controlling webviews to show
-html pages or evaluate javascript. These API:s only exist on mobile platforms."
diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html
@@ -10,17 +10,23 @@
     <!--[if lt IE 9]>
     <script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js"></script>
     <![endif]-->
+    <title>{{ site.title }}</title>
   </head>
   <body>
     <div class="wrapper">
       <header>
-        <h1><a href="{{ site.github.repository_url }}">{{ site.title | default: site.github.repository_name }}</a></h1>
+        <h1>Defold Webview API documentation</h1>
+        <p>Functions for creating and controlling webviews to show HTML pages or
+        evaluate JavaScript. These API:s only exist on mobile platforms.</p>
 
-        <p>{{ site.description | default: site.github.project_tagline }}</p>
+        <p>To use this library in your Defold project, add the following URL to your <code class="inline-code-block">game.project</code> dependencies:
+          <pre>https://github.com/defold/extension-webview/archive/master.zip</pre>
+        </p>
 
-        <a href="{{ site.github.zip_url }}">{{ site.github.zip_url }}</a>
+        <p>The source code can be viewed at: <a href="https://github.com/defold/extension-webview">https://github.com/defold/extension-webview</a></p>
 
       </header>
+      <hr>
       <section>
 
       {{ content }}

diff --git a/docs/index.md b/docs/index.md
@@ -1,10 +1,6 @@
 ---
 layout: default
 ---
-## Webview API documentation
-Functions and for creating and controlling webviews to show html pages or
-evaluate javascript. These API:s only exist on mobile platforms.
-
 ## Constants
 {% for constant in site.data.api.constants %}
 ### <code>{{ constant.name }}</code>

diff --git a/game.project b/game.project
@@ -25,3 +25,6 @@ package = com.defoldtest.webview
 [ios]
 bundle_identifier = com.defoldtest.webview
 
+[library]
+include_dirs = webview
+