Renamed parser to reader + updated some comments

Author: minirop

readme.md

@@ -1,6 +1,6 @@
 # class-rs
 
-Reads a .class file into an almost 1-to-1 matching struct or generate a .class file from said structure.\
+Reads a .class file into an almost 1-to-1 matching struct or generates a .class file from said structure.\
 ⚠️ `Constant::Utf8` are using Rust's String type and not the JVM's modified UTF-8. If you have a string that makes that crate panic, open an issue.
 
 ## Example

src/enums/mod.rs

@@ -94,7 +94,7 @@ pub enum Constant {
         class_index: u16,
         name_and_type_index: u16,
     },
-    /// Used for the first entry, and the second entry of doubles and longs.
+    /// Used for the first entry in the constant pool, and the second entry of doubles and longs.
     Invalid,
     InvokeDynamic {
         bootstrap_method_attr_index: u16,
@@ -125,6 +125,7 @@ pub enum Constant {
     String {
         string_index: u16,
     },
+    /// ⚠️ It is using Rust's String type and not the JVM's modified UTF-8. If you have a string that makes that crate panic, open an issue.
     Utf8(String),
 }
 

src/lib.rs

@@ -1,6 +1,6 @@
 //! JVM class file reader
 //!
-//! Reads a .class file into an almost 1-to-1 matching struct.
+//! Reads a .class file into an almost 1-to-1 matching struct or generates a .class file from said structure.
 
 use byteorder::{BigEndian, ReadBytesExt, WriteBytesExt};
 use std::error::Error;
@@ -20,8 +20,8 @@ pub use structs::{
     TypePath,
 };
 
-mod parser;
-use crate::parser::{
+mod reader;
+use crate::reader::{
     extract_class_flags, read_attributes, read_constant_pool, read_fields, read_interfaces,
     read_methods,
 };