Skip to content

Commit

Permalink
Improve English in docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
JeremyEllingham committed May 23, 2015
1 parent 1edf61c commit 96b6d64
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
26 changes: 13 additions & 13 deletions docs/whats_wrong_with_other_gems.md
Expand Up @@ -2,27 +2,27 @@

### What's wrong with other gems?

Just look at [Ruby-Toolbox](https://www.ruby-toolbox.com/categories/rails_comments). What we can see?
Take a look at [Ruby-Toolbox](https://www.ruby-toolbox.com/categories/rails_comments). What can we see?

* [Acts as commentable with threading](https://github.com/elight/acts_as_commentable_with_threading) - so, guys, where is the render helper for the tree? There is no helper! Should I make render helper for tree by myself? Nooooo!!! I'm so sorry, but I can't use this gem.
* [acts_as_commentable](https://github.com/jackdempsey/acts_as_commentable) - so, I can see code for models. But I can't see code for controllers and views. Unfortunately, there is no threading. It's not enough for me.
* [opinio](https://github.com/Draiken/opinio) - looks better, but there is no threading. I want to have more!
* [has_threaded_comments](https://github.com/aarongough/has_threaded_comments) - Nice work! Nice gem! Models, controllers, views, view helper for tree rendering! **But**, last activity 2 years ago, I need few features, I think - I can make it better.
* [Acts as commentable with threading](https://github.com/elight/acts_as_commentable_with_threading) - Where is the render helper for the tree? There is no helper! Am I supposed to write a render helper for the tree myself? Nooooo!!! I'm sorry, I can't use this gem.
* [acts_as_commentable](https://github.com/jackdempsey/acts_as_commentable) - I can see the code for models. But I can't see the code for controllers and views. Unfortunately, there is no threading. This isn't enough for me.
* [opinio](https://github.com/Draiken/opinio) - Better, but still no threading. I can do better!
* [has_threaded_comments](https://github.com/aarongough/has_threaded_comments) - A solid gem. Has model, controller and view helpers for tree rendering! **But** last activity was 2 years ago, it still needs a few features - I can do better.

### Why TheComments is better than others gems?
### Why is TheComments better than other gems?

1. TheComments allows for threaded comments
2. **Only TheComments has special helper for tree rendering** (based on [TheSortableTree](https://github.com/the-teacher/the_sortable_tree)).
3. TheComments designed to reduce requests to database. I say about useful cache counters.
4. TheComments has solution for [building of Recent Comments](https://github.com/the-teacher/the_comments/blob/master/docs/denormalization_and_recent_comments.md) (for polymorphic relations)
5. TheComments designed for text preprocessors (Textile, Markdown, Sanitize, Coderay etc.)
6. TheComments has admin UI based on bootstrap 3
7. TheComments is "all-in-one" solutions.<br>
3. TheComments is designed to reduce database requests. Helpful for cache counters.
4. TheComments has a solution for [building Recent Comments](https://github.com/the-teacher/the_comments/blob/master/docs/denormalization_and_recent_comments.md) (for polymorphic relations)
5. TheComments is designed for text preprocessors (Textile, Markdown, Sanitize, Coderay etc.)
6. TheComments has an admin UI based on bootstrap 3
7. TheComments is an "all-in-one" solution.<br>
It has: Models and Controllers logic (via concerns), Generators, Views, Helper for fast Tree rendering and Admin UI.
8. I'll try to help you via skype: **ilya.killich**, if you have problems with TheComments
8. If you have problems with TheComments, I'll try to help you via skype: **ilya.killich**

### TheComments based on:

1. [AwesomeNestedSet](https://github.com/collectiveidea/awesome_nested_set) - for comments threading
2. [TheSortableTree](https://github.com/the-teacher/the_sortable_tree) - for fast rendering of comments tree
3. [State Machine](https://github.com/pluginaweek/state_machine) - to provide easy and correct recalculation cache counters on states transitions
3. [State Machine](https://github.com/pluginaweek/state_machine) - to provide easy and correct recalculation cache counters on states transitions
6 changes: 3 additions & 3 deletions docs/where_is_example_application.md
Expand Up @@ -2,11 +2,11 @@

### Dummy Application

Repo of TheComments has dummy application for developmet and testing.
TheComments repository contains a dummy application for development and testing.

It's here: [Dummy App](https://github.com/the-teacher/the_comments/tree/master/spec/dummy_app)

For run dummy app, your should do that:
To run the dummy app:

```ruby
git clone https://github.com/the-teacher/the_comments.git
Expand All @@ -22,7 +22,7 @@ rails s -p 3000 -b localhost

### Run tests

Following instructions should helps to run simple tests:
To run the RSPEC tests:

```ruby
git clone https://github.com/the-teacher/the_comments.git
Expand Down

0 comments on commit 96b6d64

Please sign in to comment.