Update README.md

README.md

@@ -1,3 +1,66 @@
 ---
 license: mit
+language:
+- en
+- zh
+library_name: transformers
+tags:
+- code
 ---
+
+Bash Copilot is an LLM to generate bash command line or script based on your input of natural language description. 
+This model supports multiturn conversation, which means you can (1) implicitly refer to an formerly mentioned entity using pronoun or omitting it, (2) optimize or complete the target code step by step.
+
+Bash Copilot is a fine-tuned version of Yi-1.5-6B with 21k multiturn conversations of both Chinese and English that converts natural language to bash code. 
+The source corpus is collected from github repos of more than 500 stars. The dataset will be released with next release of BashCopilot-6B (non-preview version).
+
+Here are some examples:
+
+```
+<|im_start|>user
+compare id field of a.json and b.json
+<|im_end|>
+
+<|im_start|>assistant
+diff <(jq -r '.id' a.json) <(jq -r '.id' b.json)<|im_end|>
+
+<|im_start|>user
+print the bigger one
+<|im_end|>
+
+<|im_start|>assistant
+echo $(( $(jq -r '.id' a.json) > $(jq -r '.id' b.json)? $(jq -r '.id' a.json) : $(jq -r '.id' b.json) ))<|im_end|>
+```
+
+
+
+```
+<|im_start|>user
+count the file under /path/to/target
+<|im_end|>
+
+<|im_start|>assistant
+find /path/to/target -type f | wc -l<|im_end|>
+
+<|im_start|>user
+write this to count.sh
+<|im_end|>
+
+<|im_start|> assistant
+echo "find /path/to/target -type f | wc -l" > count.sh<|im_end|>
+
+<|im_start|>user
+repeatedly run it until it returns 10, then break the loop
+<|im_end|>
+
+<|im_start|>assistant
+while [ $($count.sh) -ne 10 ]; do sleep 1; done<|im_end|>
+
+<|im_start|>user
+instead of sleep, send "not ready" to 1.2.3.4:8888 via TCP
+<|im_end|>
+
+<|im_start|>assistant
+while [ $($count.sh) -ne 10 ]; do echo not ready > /dev/tcp/1.2.3.4/8888; sleep 1; done
+<|im_end|>
+```