docs: Update README.md with configuration instructions (#130)

cauliyang · web-flow · commit fc4029f94578 · 2023-07-20T13:13:39.000+08:00
* docs: Update README.md with configuration instructions

* docs: add configuration explanation
diff --git a/README.md b/README.md
@@ -24,9 +24,11 @@ cargo install leetcode-cli
 <summary>Shell completions</summary>
 
 For Bash and Zsh (by default picks up `$SHELL` from environment)
+
 ```sh
 eval "$(leetcode completions)"
 ```
+
 Copy the line above to `.bash_profile` or `.zshrc`
 
 You may also obtain specific shell configuration using.
@@ -72,8 +74,16 @@ For example, given this config (could be found at `~/.leetcode/leetcode.toml`):
 [code]
 editor = 'emacs'
 # Optional parameter
-editor-args = ['-nw']
+editor_args = ['-nw']
 lang = 'rust'
+edit_code_marker = false
+start_marker = ""
+end_marker = ""
+# if include problem description
+comment_problem_desc = false
+# comment syntax
+comment_leading = ""
+test = true
 
 [cookies]
 csrf = '<your-leetcode-csrf-token>'
@@ -86,6 +96,96 @@ root = '~/.leetcode'
 scripts = 'scripts'
 ```
 
+<details>
+  <summary>Configuration Explanation</summary>
+
+```toml
+[code]
+editor = 'emacs'
+# Optional parameter
+editor_args = ['-nw']
+lang = 'rust'
+edit_code_marker = true
+start_marker = "start_marker"
+end_marker = "end_marker"
+# if include problem description
+comment_problem_desc = true
+# comment syntax
+comment_leading = "//"
+test = true
+
+[cookies]
+csrf = '<your-leetcode-csrf-token>'
+session = '<your-leetcode-session-key>'
+
+[storage]
+cache = 'Problems'
+code = 'code'
+root = '~/.leetcode'
+scripts = 'scripts'
+```
+
+If we change the configuration as shown previously, we will get the following code after `leetcode edit 15`.
+
+```rust
+// Category: algorithms
+// Level: Medium
+// Percent: 32.90331%
+
+// Given an integer array nums, return all the triplets [nums[i], nums[j], nums[k]] such that i != j, i != k, and j != k, and nums[i] + nums[j] + nums[k] == 0.
+//
+// Notice that the solution set must not contain duplicate triplets.
+//
+//  
+// Example 1:
+//
+// Input: nums = [-1,0,1,2,-1,-4]
+// Output: [[-1,-1,2],[-1,0,1]]
+// Explanation:
+// nums[0] + nums[1] + nums[2] = (-1) + 0 + 1 = 0.
+// nums[1] + nums[2] + nums[4] = 0 + 1 + (-1) = 0.
+// nums[0] + nums[3] + nums[4] = (-1) + 2 + (-1) = 0.
+// The distinct triplets are [-1,0,1] and [-1,-1,2].
+// Notice that the order of the output and the order of the triplets does not matter.
+//
+//
+// Example 2:
+//
+// Input: nums = [0,1,1]
+// Output: []
+// Explanation: The only possible triplet does not sum up to 0.
+//
+//
+// Example 3:
+//
+// Input: nums = [0,0,0]
+// Output: [[0,0,0]]
+// Explanation: The only possible triplet sums up to 0.
+//
+//
+//  
+// Constraints:
+//
+//
+// 3 <= nums.length <= 3000
+// -10⁵ <= nums[i] <= 10⁵
+//
+
+// start_marker
+impl Solution {
+pub fn three_sum(nums: Vec<i32>) -> Vec<Vec<i32>> {
+
+    }
+
+}
+// end_marker
+
+```
+
+</details>
+
+<br>
+
 #### 1. <kbd>pick</kbd>
 
 ```sh
@@ -195,7 +295,6 @@ Open Firefox, press F12, and click `Storage` tab.
 
 Expand `Cookies` tab on the left and select https://leetcode.com.
 
-
 #### Step 2
 
 Copy `Value` from `LEETCODE_SESSION` and `csrftoken` to `session` and `csrf` in your configuration file, respectively:
