Skip to content

Commit 4d2ff28

Browse files
authored
Minor syntax fixes in readme.
1 parent 719c103 commit 4d2ff28

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

readme.rst

+7-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,13 @@
11
colorgram.py
22
============
3+
34
**colorgram.py** is a Python library that lets you extract colors from images. Compared to other libraries, the colorgram algorithm's results are more intense.
45

56
colorgram.py is a port of `colorgram.js <https://github.com/darosh/colorgram-js>`__, a JavaScript library written by GitHub user `@darosh <https://github.com/darosh>`__. The goal is to have 100% accuracy to the results of the original library (a goal that is met). I decided to port it since I much prefer the results the colorgram algorithm gets over those of alternative libraries - have a look in the next section.
67

78
Results
89
-------
10+
911
.. image:: http://i.imgur.com/11Pohrk.png
1012
:alt: Results of colorgram.py on a 512x512 image
1113

@@ -23,6 +25,8 @@ You can install colorgram.py with `pip <https://pip.pypa.io/en/latest/installing
2325
How to use
2426
----------
2527

28+
Using colorgram.py is simple. Mainly there's only one function you'll need to use - ``colorgram.extract``.
29+
2630
Example
2731
'''''''
2832

@@ -47,9 +51,10 @@ Extract colors from an image. ``image`` may be either a path to a file, or a fil
4751
``colorgram.Color``
4852
'''''''''''''''''''
4953
A color extracted from an image. Its properties are:
54+
5055
* ``Color.rgb`` - The color represented as RGB from 0 to 255, e.g. ``(255, 151, 210)``.
51-
* ``Color.hsl`` - The color represented as HSL from 0 to 255, e.g. ``(230, 104, 255)``
52-
* ``Color.proportion``` - The proportion of the image that is in the extracted color from 0 to 1, e.g. ``0.34``
56+
* ``Color.hsl`` - The color represented as HSL from 0 to 255, e.g. ``(230, 104, 255)``.
57+
* ``Color.proportion`` - The proportion of the image that is in the extracted color from 0 to 1, e.g. ``0.34``.
5358

5459
Sorting by HSL
5560
''''''''''''''

0 commit comments

Comments
 (0)