Skip to content

Commit

Permalink
📝 Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
pleonex committed Nov 22, 2015
1 parent 648b914 commit 194c3f3
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
19 changes: 17 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -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.
Binary file added demo.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 194c3f3

Please sign in to comment.