wrote some readme stuff, created js file

Author: kevb34ns

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2017 Kevin Yang
+Copyright (c) 2017 Kevin K. Yang
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -1,2 +1,11 @@
 # pinyinify
-Convert pinyin tone numbers to Unicode tone marks.
+A simple JavaScript function for converting pinyin containing tone numbers (`pin4yin1`) to pinyin using standard Unicode tone marks (<code>pi&#768;nyi&#772;n</code>).
+
+## Usage
+The function `pinyinify()` takes a string parameter, which can be one of the following:
+
++ A single character, which must be one of: `a`, `e`, `i`, `o`, `u`, or <code>&#252;</code>, followed by a tone mark. `v` is an acceptable substitute for <code>&#252;</code>.
++ A pinyin word or phrase using tone numbers. Examples: `mao1`, `chi1fan4`, `wo3men5`. For simplicity's sake, the function will process most words with tone numbers, including ones that may not be valid pinyin.
++ A string containing both pinyin words and non-pinyin words, characters, or symbols. Example: `My Chinese name is yang2kai3wen2.` **Be careful:** any word that resembles the structure of pinyin (has a number at the end of it, for example) may be given tone marks. Therefore, it is recommended that you avoid this option if possible.
+
+If you pass a string that meets one of the requirements above, the function will return a string with the tone numbers converted to tone marks. Otherwise, it will return an unchanged string.

pinyinify.js

@@ -0,0 +1,4 @@
+
+var pinyinify = function(str) {
+
+}