added note for profile_name convention

58bc2dac · Christopher Lee · 7ab8ff9b · 58bc2dac
Commit 58bc2dac authored Aug 26, 2014 by Christopher Lee
Show whitespace changes
Inline Side-by-side

Showing with 9 additions and 0 deletions

README.md
+9 -0

No files found.
--- a/README.md
+++ b/README.md
 edx-val
 =======
+
+Note:
+    The naming convetion for the `profile_name` in `Profile` objects will be the
+    medium of the profile (a-z), an underscore, and then the quality (a-z).
+
+    Examples:
+    desktop_high
+    mobile_medium
+    somethingelse_low