diff --git a/README.md b/README.md index 6f7166a..3714774 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,19 @@ # Autocomplete XML Atom Package -**Note:** This is an alpha version. It is **not** fully implemented. +**Note: This is an alpha version. It is not fully implemented.** -XML tag and attribe autocompletions in Atom. Install [autocomplete-plus](https://github.com/atom-community/autocomplete-plus) before installing this package. +XML tag autocompletion for Atom text editor! + +![Demo](demo.gif) + +# Features +* Download and parse XSD files (at the moment only ComplexTypes). +* Show autocompletation for tags with documentation if available. + +# Code structure +The package code is inside the *lib* folder. + +* *lib* + * **main.coffee**: Main package file. It handles package things like calling the provider and settings. + * **provider.coffee**: Detects the type of suggestion needed (e.g.: tag, attribute, ...) and ask for suggestions of that type. It handles everything related with the editor. + * **xsd.coffee**: Manage the XSD types. Create suggestions. It handles suggestion creation. + * **xsdParser.coffee**: Download and parse a XSD file and build the types. It handles XSD parsing. diff --git a/demo.gif b/demo.gif new file mode 100644 index 0000000..0363409 Binary files /dev/null and b/demo.gif differ