Skip to content

Latest commit

 

History

History
35 lines (24 loc) · 1.96 KB

README.md

File metadata and controls

35 lines (24 loc) · 1.96 KB
Raw

#Kumquat Ext Framework

Kumquat is a framework aimed on fast extensions developing for Google Chrome. Using it you can focus on primary tasks, such as describing extension's appearance and behaviour, instead of sorting out with the file structure, routers and so on. Literally, sorting out with the file system is unnecessary — Kumquat has a Command Line API, where it's possible to create, remove modules, build extension, minify files. The other convenient side of its using is the amount of built-in functions and methods: Prevel Library API is available, plus there're a few extensions (they are optional to load).

###Command Line API

This API is written in Node.js. It's aimed on getting you rid of unpleasant dealing with the file system of the project and writing confusing routers. Everything what you will need using Kumquat is to create a new module or an extension (Kumquat Kernel Extension, had in mind); and these two actions are available to do within Command Line. Moreover, it supports building the project and minifying JavaScript (with UglifyJS).

How-to create a new module (example):

cd path/to/Kumquat/cl
node cl.js create hub translator

###File structure

  • cl/ - Command Line API;

  • pages/ - All html files;

  • resources/ - Styles and images;

  • src/ - All JavaScript code of the client side;

  • Buildfile - it's an analogue of standard Chrome's manifest.json, but with a few correction aimed on simplifying.