chore: update README

Author: fursich

README.md

@@ -1,30 +1,28 @@
-# MarkdownIt
+# MarkdownItRubyfiedSample
 
-TODO: Delete this and the text below, and describe your gem
+The gem is built based on [markdown-it-rust](https://github.com/markdown-it-rust/markdown-it), which provides a super powerful parser mechanisms with highly-customizeable modular design. (I recommend you to check markdown-it-rust github page if you are interested!)
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/markdown_it_ruby`. To experiment with that code, run `bin/console` for an interactive prompt.
+On top of default parser plugins, this gem adds a few utility add-ons that can be activated via options
+Packaged as Ruby gem (NOTE: it's still experimental)
 
 ## Installation
 
-TODO: Replace `UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG` with your gem name right after releasing it to RubyGems.org. Please do not do it earlier due to security reasons. Alternatively, replace this section with instructions to install your gem from git if you don't plan to release to RubyGems.org.
-
-Install the gem and add to the application's Gemfile by executing:
-
-    $ bundle add UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
-
-If bundler is not being used to manage dependencies, install the gem by executing:
-
-    $ gem install UPDATE_WITH_YOUR_GEM_NAME_IMMEDIATELY_AFTER_RELEASE_TO_RUBYGEMS_ORG
+Just clone the repository and try `bundle exec rake compile` to compile the executable.
+(bundler >= 2.4, RubyGems 3.4.6 required)
 
 ## Usage
 
-TODO: Write usage instructions here
-
-## Development
-
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+* using with console
+```
+$ bin/console
+> 
+```
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+* benchmark
+```
+$ cd bench
+$ ruby bench.rb
+```
 
 ## Contributing
 
@@ -36,4 +34,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the MarkdownIt project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/markdown_it_ruby/blob/main/CODE_OF_CONDUCT.md).
+Everyone interacting in the MarkdownItRubyfiedSample project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/markdown_it_ruby/blob/main/CODE_OF_CONDUCT.md).