- Technical documentation
- API docs
The readme.html file
Application packages can contain an HTML formatted readme file. It is intended to give a more detailed, technical description of the application than the short_description and appstore_description fields of the manifest gives. The readme.html is displayed when packages are viewed individually in the Spaceify registry or when the technical documentation view is selected in the Spaceify AppStore.
The file must be always located in the application/ directory of the package - application/readme.html.
When an application or a spacelet is published to the Spaceify registry its www-directory (if it has one) is copied to a directory created to the registry for it. The readme.html can load the files it needs from the www-directory.
<!DOCTYPE html> <html> <head> <link href="www/readme.css" rel="stylesheet" type="text/css" media="screen"> </head> <body> <img src="www/images/logo.gif"> Application package description goes here... </body> </html>