Skip to content

Commit 0fb5220

Browse files
author
John Doherty
committed
tweaked readme
1 parent 512b47a commit 0fb5220

File tree

1 file changed

+9
-4
lines changed

1 file changed

+9
-4
lines changed

README.MD

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
# node-iframe-replacement
22
[![npm version](https://badge.fury.io/js/node-iframe-replacement.svg)](https://badge.fury.io/js/node-iframe-replacement) [![Run Status](https://api.shippable.com/projects/5869721607d5371300747182/badge?branch=master)](https://app.shippable.com/projects/5869721607d5371300747182)
33

4+
## Motivation
45
Imagine the scenario: you've built a lovely web app for a business, who later insists it goes live within an iframe of their corp website. You resist, but you're ultimatley forced to bastardize your app to make it work.
56

67
[node-iframe-replacement](https://github.com/john-doherty/node-iframe-replacement) is the compromise. A small node server that grabs the source code of an external website and injects your content - thus allowing you to host your app on a subdomain and without an iframe. Changes to the external site _(navigation etc)_ are automatically picked up every 5 minutes and reflected in your app.
@@ -86,16 +87,20 @@ To ensure the source scripts, styles and images load within your site a base tag
8687

8788
Because of this, you need to ensure all the links within your conent are absolute.
8889

89-
## History
90-
91-
This project is a rethought, rebranded, relaunched version of my badly named [express-render-template](https://www.npmjs.com/package/express-render-template) module released in Arpil 2016.
92-
9390
## Notes on Pull Requests & Patches
9491

9592
* Fork the project
9693
* Make your feature addition or bug fix
9794
* Send me a pull request
9895

96+
## Bugs
97+
98+
Please raise bugs via the [node-iframe-replacement issue tracker](https://github.com/john-doherty/node-iframe-replacement/issues) and, if possible, provide enough information to allow the issue to be reproduced.
99+
100+
## History
101+
102+
This project is a rethought, rebranded, relaunched version of my badly named [express-render-template](https://www.npmjs.com/package/express-render-template) module released in Arpil 2016.
103+
99104
## License
100105

101106
[ISC License](LICENSE) © 2016 [John Doherty](https://twitter.com/CambridgeMVP)

0 commit comments

Comments
 (0)