prettytodo 0.0.2 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92afc86f7bce21c2455eeff44c42283aab75c33ecd0a04c13ccab27f9f0e650c
-  data.tar.gz: b40236afb1a3fd7caae91be41cd3bc778706a9c52107c14efe219b5b59b8acc6
+  metadata.gz: b8b4f168773ccf02a270aa623dcabd313406c324da2f5ff72bc8ec8263361545
+  data.tar.gz: a6bc45a7406d1fcaa494ca073f0e6f4b60f1a7ef46e4b76ae479374a20f61827
 SHA512:
-  metadata.gz: f3d878bc88379d5b12ed2bf1c708e887490374d188b04eaa16184edf8bd293694f18e95f30ff40332c0a67e9fe831330e946bd85a5df26826a851f668d4433b1
-  data.tar.gz: 10402be8ce6aabc63422731bbd05d13c6c91ac6d4c18e13748708c6f66e42f7af312a2bba17e13ac8131494b78f93a1b424cda85034d99b77af66909dfaf6526
+  metadata.gz: a3e6b7148c0dcdfd768ad2f93c9edaf051be1331a70cb6e650fa7bc6bc7dac49ed4954585821122206d7a9d646e73f79a5a47757453a9488135ac1e88eba1621
+  data.tar.gz: 44ab495d54ebf20ec79d02575460557cb98a4e440ab3d3c9ff9f90415e84753b83ad7053b7a46d8247085a5ab856e6375f18bc2aeeed4582523bc392d23d1d8a

data/README.md

@@ -1,28 +1,48 @@
-# Prettytodo
-Short description and motivation.
+# 🌸 Pretty Todo 🌸
 
-## Usage
-How to use my plugin.
+A Rails engine that transforms your code annotations into an organized, visual interface. Built on top of `bin/rails notes`, Pretty Todo makes managing your code todos a delightful experience :)
+
+## Features
+
+- Visual interface for your code annotations
+- Supports standard tags: `TODO`, `OPTIMIZE`, `FIXME`
+- Customizable tag support
+- Development-only mounting for security
 
 ## Installation
-Add this line to your application's Gemfile:
+
+1. Add to your application's Gemfile:
 
 ```ruby
 gem "prettytodo"
 ```
 
-And then execute:
-```bash
-$ bundle
+2. Mount the engine in your `config/routes.rb`:
+
+```ruby
+mount Prettytodo::Engine => '/prettytodo' if Rails.env.development?
+```
+
+## Configuration
+
+Add custom annotation tags in `config/application.rb`:
+
+```ruby
+config.annotations.register_tags('HACK', 'REVIEW')
 ```
 
-Or install it yourself as:
-```bash
-$ gem install prettytodo
+## Usage
+
+1. Add annotations to your code using standard Rails comment format:
+
+```ruby
+# TODO: Refactor this method
+# FIXME: Handle edge case
+# OPTIMIZE: Improve performance
 ```
 
-## Contributing
-Contribution directions go here.
+2. Visit `/prettytodo` in your development environment to see your annotations in a beautiful interface.
 
 ## License
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+This project is licensed under the [MIT License](https://opensource.org/licenses/MIT).

data/lib/prettytodo/version.rb

@@ -1,3 +1,3 @@
 module Prettytodo
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: prettytodo
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors:
 - Marisa Lopez
@@ -34,21 +34,14 @@ files:
 - MIT-LICENSE
 - README.md
 - Rakefile
-- app/assets/config/prettytodo_manifest.js
-- app/assets/stylesheets/prettytodo/application.css
 - app/controllers/prettytodo/application_controller.rb
 - app/controllers/prettytodo/notes_controller.rb
-- app/helpers/prettytodo/application_helper.rb
-- app/jobs/prettytodo/application_job.rb
-- app/mailers/prettytodo/application_mailer.rb
-- app/models/prettytodo/application_record.rb
 - app/views/layouts/prettytodo/application.html.erb
 - app/views/prettytodo/notes/index.html.erb
 - config/routes.rb
 - lib/prettytodo.rb
 - lib/prettytodo/engine.rb
 - lib/prettytodo/version.rb
-- lib/tasks/prettytodo_tasks.rake
 homepage: https://github.com/celina-lopez/prettytodo
 licenses:
 - MIT

data/app/assets/config/prettytodo_manifest.js

@@ -1 +0,0 @@
-//= link_directory ../stylesheets/prettytodo .css

data/app/assets/stylesheets/prettytodo/application.css

@@ -1,15 +0,0 @@
-/*
- * This is a manifest file that'll be compiled into application.css, which will include all the files
- * listed below.
- *
- * Any CSS and SCSS file within this directory, lib/assets/stylesheets, vendor/assets/stylesheets,
- * or any plugin's vendor/assets/stylesheets directory can be referenced here using a relative path.
- *
- * You're free to add application-wide styles to this file and they'll appear at the bottom of the
- * compiled file so the styles you add here take precedence over styles defined in any other CSS/SCSS
- * files in this directory. Styles in this file should be added after the last require_* statement.
- * It is generally better to create a new file per style scope.
- *
- *= require_tree .
- *= require_self
- */

data/app/helpers/prettytodo/application_helper.rb

@@ -1,4 +0,0 @@
-module Prettytodo
-  module ApplicationHelper
-  end
-end

data/app/jobs/prettytodo/application_job.rb

@@ -1,4 +0,0 @@
-module Prettytodo
-  class ApplicationJob < ActiveJob::Base
-  end
-end

data/app/mailers/prettytodo/application_mailer.rb

@@ -1,6 +0,0 @@
-module Prettytodo
-  class ApplicationMailer < ActionMailer::Base
-    default from: "from@example.com"
-    layout "mailer"
-  end
-end

data/app/models/prettytodo/application_record.rb

@@ -1,5 +0,0 @@
-module Prettytodo
-  class ApplicationRecord < ActiveRecord::Base
-    self.abstract_class = true
-  end
-end

data/lib/tasks/prettytodo_tasks.rake

@@ -1,4 +0,0 @@
-# desc "Explaining what the task does"
-# task :prettytodo do
-#   # Task goes here
-# end