search

scour-project / scour

Scour - An SVG Optimizer / Cleaner
Apache License 2.0
765 stars 60 forks source link

Improve the project's README #29

Open oberstet opened 8 years ago

oberstet commented 8 years ago

IMO, scour really deserves a better README. both visually, and content wise, as the first user experience / contact with scour will either be

ottok commented 4 years ago

SVG files are XML and might have payloads that potentially cause security issues. Does Scour sanitize away potential code injections like e.g. http://svg.enshrined.co.uk/ does?

If so, this could be mentioned in the project README.

oberstet commented 4 years ago

not sure;)

potential code injections

can you describe those?

are there test cases here

https://github.com/darylldoyle/svg-sanitizer/tree/master/tests/data

?

if so, we could just see (run scour) and possibly add those here. we have automated tests https://travis-ci.org/github/scour-project/scour as well ..

ottok commented 4 years ago

Ok, so I guess you have not developed Scour with security sanitization in mind. I'll open a new issue about it in #254.

JoKalliauer commented 4 years ago

@oberstet : There is also an explantation of the optional scourattributes.

Maybe you should list what should be improve. -What's the advantages of scour -What's the options of scour -How to use it (including examples) -adding benchmarks as https://github.com/RazrFalcon/svgcleaner/#charts -How to install -Why you should be careful and not overwrite originals -....