readme

README.md

@@ -1,11 +1,17 @@
-# Full-featured 2d graphics library for Nim.
+# Pixie - A full-featured 2D graphics library for Nim
 
-Written in pure nim. Basis for the fidget UI library.
+⚠️ WARNING: This library is still in heavy development. ⚠️
 
-Features:
+Pixie is a 2D graphics library similar to [Cairo](https://www.cairographics.org/) and [Skia](https://skia.org) written entirely in Nim.
- * images
- * paths
- * masks
 
-Supported File formats reading and writing:
+Features include:
- * BMP (RGBA Only)
+* Drawing paths, shapes and curves
+* Complex masking
+* Shadows, glows and effects
+* Loading image file formats (PNG, BMP, + more in development)
+
+This library is being actively developed and is not yet ready for use. Since you've managed to stumble onto it, give it a star and check back soon!
+
+## Testing
+
+`nimble test`

src/pixie.nim

@@ -21,7 +21,7 @@ proc toImage*(mask: Mask): Image =
   for i in 0 ..< mask.data.len:
     result.data[i].a = mask.data[i]
 
-proc decodeImage(data: string | seq[uint8]): Image =
+proc decodeImage*(data: string | seq[uint8]): Image =
   ## Loads an image from a memory.
   if data.len > 8 and cast[array[8, uint8]](data.readUint64(0)) == pngSignature:
     return decodePng(data)
@@ -35,7 +35,7 @@ proc readImage*(filePath: string): Image =
   ## Loads an image from a file.
   decodeImage(readFile(filePath))
 
-proc encodeImage(image: Image, fileFormat: FileFormat): string =
+proc encodeImage*(image: Image, fileFormat: FileFormat): string =
   ## Encodes an image into a memory.
   case fileFormat:
   of ffPng: