svg.escobar.life

A simple SVG markup editor for the web

Commit: 066a24af61532edc9828de209a0258295e6f235b
Parent: c668791baa2670d84eef71b6ecab2be7280a58fd
Author: Pablo <pablo-escobar@riseup.net>
Date: Tue, 11 May 2021 00:44:29 +0000

Refactored the README

Added some information on my goals to the README

Diffstat

1 file changed, 13 insertions, 11 deletions

Status	File Name	N° Changes	Insertions	Deletions
Modified	README.md	24	13	11

diff --git a/README.md b/README.md
@@ -1,26 +1,28 @@
 # SVG Editor
 
-A simple, visual SVG markup editor for the web
+A simple, visual SVG markup editor for the web. This editor solves a very
+specific problem:
+
+* I can edit the source code of SVG files in a text editor
+* I can view the changes I made in an editor like Inkscape
+* I cannot do them both at the same time
+
+This editor alows users the edit the source code of the image and preview the
+results instantly.
 
 ## Running This on Your Server
 
 Despite the looks, this is a completely static application. In other words, to
 run this on you server just dump the files somewhere.
 
-## Building the Website
+### Build Dependencies
 
-This is an [Elm](https://elm-lang.org/) application, so compiling it is simple
-enought. [uglifyjs](https://www.npmjs.com/package/uglify-js) is used to minify
-the JS.
+* [Elm](https://elm-lang.org/)
+* [uglifyjs](https://www.npmjs.com/package/uglify-js)
 
-To build the website simply run
+### Building the Website
 
 ```
 $ make build
 ```
 
-### Dependencies
-
-* [Elm](https://elm-lang.org/)
-* [uglifyjs](https://www.npmjs.com/package/uglify-js)
-