added description

florianburger · Aug 28, 2017 · 9ff7e42 · 9ff7e42
1 parent fa77584
commit 9ff7e42
Showing 1 changed file with 2 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,7 @@
 # SimpleSitemapGenerator
 
+Generates a sitemap by crawling your site. Uses streams to efficiently write the sitemap to your drive and runs asynchronously to avoid blocking the thread. Is cappable of creating multiple sitemaps if threshold is reached. Respects robots.txt and meta tags.
+
 ## Usage
 ```JavaScript
 const fs = require('fs');