prepare preview release

rogalmic · Dec 30, 2018 · 418b058 · 418b058
1 parent 59243ac
commit 418b058
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 33 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -37,12 +37,12 @@ deploy:
     on:
       branch: master
       condition: "$TRAVIS_OS_NAME == linux"
-  # - provider: script
-  #   script: vsce publish -p $VSCE_TOKEN --packagePath *.vsix
-  #   skip_cleanup: true
-  #   on:
-  #     tags: true
-  #     condition: "$TRAVIS_TAG =~ $RELEASE_TAG_EXPRESSION"
+  - provider: script
+    script: vsce publish -p $VSCE_TOKEN --packagePath *.vsix
+    skip_cleanup: true
+    on:
+      tags: true
+      condition: "$TRAVIS_TAG =~ $RELEASE_TAG_EXPRESSION"
 
 cache:
   directories:

diff --git a/README.md b/README.md
@@ -1,28 +1,36 @@
 # Xml Complete
 
-This extension helps with editing XML files with schema location set. It does not require any runtime like `java`, `python` or `xmllint`.
+This extension helps with editing XML files by providing hints.
+
+It does not require any runtime like `java`, `python` or `xmllint`, while does partial XSD parsing.
 
 ## Features
 
-Plans:
-- no platform dependencies ever [**done**]
-- no excessive configuration in VSCode [**done**]
-- XSD reading from XML schemaLocation attribute [**ongoing**]
-- basic and realtime linter (XML + optional XSD) [**ongoing**]
-- fast autocomplete based on XSD [**ongoing**]
-- formatting XML [**planned**]
+- Basic linter (XML + partial XSD validation)
 
-## Samples
+[<img src="https://raw.githubusercontent.com/rogalmic/vscode-xml-complete/gif/images/vscode-xml-complete-linter.png" width="400" style="filter: blur(1px); " title="Click to show in browser"/>](https://raw.githubusercontent.com/rogalmic/vscode-xml-complete/gif/images/vscode-xml-complete-linter.png)
 
-### Local schema file
-```xml
-<root
-...
-xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-xsi:schemaLocation="file:///C:/Users/rogalmic/Documents/src/Avalonia/src/Markup/Avalonia.xsd"
-/>
+- Fast autocomplete based on XSD
+
+[<img src="https://raw.githubusercontent.com/rogalmic/vscode-xml-complete/gif/images/vscode-xml-complete-complete.png" width="400" style="filter: blur(1px); " title="Click to show in browser"/>](https://raw.githubusercontent.com/rogalmic/vscode-xml-complete/gif/images/vscode-xml-complete-complete.png)
+
+- Formatting XML
+
+[<img src="https://raw.githubusercontent.com/rogalmic/vscode-xml-complete/gif/images/vscode-xml-complete-format.png" width="400" style="filter: blur(1px); " title="Click to show in browser"/>](https://raw.githubusercontent.com/rogalmic/vscode-xml-complete/gif/images/vscode-xml-complete-format.png)
+
+## Configuration
+
+### Extension configuration per XML namespace
+```javascript
+"xmlComplete.schemaMapping":
+[
+ {
+  "xmlns": "https://github.com/avaloniaui",
+  "xsdUri": "https://raw.githubusercontent.com/rogalmic/vscode-xml-complete/master/test/Avalonia/AvaloniaXamlSchema.xsd"
+ }
+]
 ```
-### Remote schema file
+### Using `schemaLocation` attribute
 ```xml
 <root
 ...
@@ -42,11 +50,7 @@ xsi:schemaLocation="https://raw.githubusercontent.com/rogalmic/vscode-xml-comple
 | `https`   | XSD from https server           | `https://www.example.com/path/to/name`
 
 
-## Requirements
-
-*If you have any requirements or dependencies, add a section describing those and how to install and configure them.*
-
 ## Known Issues
 
-*Calling out known issues can help limit users opening duplicate issues against your extension.*
+- This is a preview version, lots of bugs expected...
 
diff --git a/package.json b/package.json
@@ -26,12 +26,30 @@
   "bugs": {
     "url": "https://github.com/rogalmic/vscode-xml-complete/issues"
   },
+  "badges": [
+    {
+      "url": "https://img.shields.io/github/downloads/rogalmic/vscode-xml-complete/latest/total.svg",
+      "href": "https://github.com/rogalmic/vscode-xml-complete/releases/latest",
+      "description": "Download latest beta release (master branch)"
+    },
+    {
+      "url": "https://img.shields.io/github/stars/rogalmic/vscode-xml-complete.svg?style=social&label=Stars",
+      "href": "https://github.com/rogalmic/vscode-xml-complete/stargazers",
+      "description": "Star the project in github"
+    },
+    {
+      "url": "https://img.shields.io/badge/paypal-donate-blue.svg",
+      "href": "https://paypal.me/rogalmic",
+      "description": "Donate some $ to keep project going"
+    }
+  ],
   "keywords": [
     "xml",
     "xsd",
     "completion",
     "linter",
-    "lint"
+    "lint",
+    "format"
   ],
   "activationEvents": [
     "onLanguage:xml"
@@ -53,8 +71,7 @@
 					"type": "array",
 					"scope": "resource",
 					"default": [
-            { "xmlns": "https://github.com/avaloniaui", "xsdUri": "https://raw.githubusercontent.com/rogalmic/vscode-xml-complete/master/test/Avalonia/AvaloniaXamlSchema.xsd"},
-            { "xmlns": "http://www.w3.org/1999/xhtml", "xsdUri": "https://raw.githubusercontent.com/stefangrunert/XHTML5-XML-Schema/master/xhtml5.xsd"}
+            { "xmlns": "https://github.com/avaloniaui", "xsdUri": "https://raw.githubusercontent.com/rogalmic/vscode-xml-complete/master/test/Avalonia/AvaloniaXamlSchema.xsd"}
           ]
         }
       }

diff --git a/src/extension.ts b/src/extension.ts
@@ -57,8 +57,7 @@ function loadConfiguration(): void {
 	globalSettings = <IXmlCompleteSettings>{
 		schemaMapping: section.get('schemaMapping',
 			[
-				{ "xmlns": "https://github.com/avaloniaui", "xsdUri": "https://raw.githubusercontent.com/rogalmic/vscode-xml-complete/master/test/Avalonia/AvaloniaXamlSchema.xsd" },
-				{ "xmlns": "http://www.w3.org/1999/xhtml", "xsdUri": "https://raw.githubusercontent.com/stefangrunert/XHTML5-XML-Schema/master/xhtml5.xsd" }
+				{ "xmlns": "https://github.com/avaloniaui", "xsdUri": "https://raw.githubusercontent.com/rogalmic/vscode-xml-complete/master/test/Avalonia/AvaloniaXamlSchema.xsd" }
 			])
 	};
 }