* Refactored manga reader to use a regular image element for all cases except for split page rendering
* Fixed a weird issue where ordering of routes broke redireciton in one case.
* Added comments to a lot of the enums and refactored READER_MODE to be ReaderMode and much more clearer on function.
* Added bookmark effect on image renderer
* Implemented keyboard shortcut modal
* Introduced the new layout mode into the manga reader, updated preferences, and updated bookmark to work for said functionality. Need to implement renderer now
* Hooked in ability to show double pages but all the css is broken. Committing for help from Robbie.
* Fixed an issue where Language tag in metadata edit wasn't being updated
* Fixed up some styling on mobile for edit series detail
* Some css fixes
* Hooked in ability to set background color on reader (not implemented in reader). Optimized some code in ArchiveService to avoid extra memory allocations.
* Hooked in background color, generated the migration
* Fixed a bug when paging to cover images, full height would be used instead of full-width for cover images
* New option in reader to show screen hints (on by default). You can disable in user preferences which will stop showing pagination overlay hints
* Lots of fixes for double rendering mode
* Bumped the amount of cached pages to 8
* Fixed an issue where dropdowns weren't being locked on form manipulation
* Cleaned up some old code in download bookmark that could create pointless temp folders.
* Fixed a bad http call on reading list remove read and cleaned up the messaging
* Undid an optimization in finding cover image due to it perfoming depth first rather than breadth.
* Updated CleanComicInfo to have Translators and CoverArtists, which were previously missing.
* Renamed Refresh Metadata to Refresh Covers on the UI, given Metadata refresh is done in Scan.
* Library detail will now retain the search query in the UI. Reduced the amount of api calls to the backend on load.
* Reverted allowing the filter to reside in the UI (even though it does work).
* Updated the Age Rating to match the v2.1 spec.
* Fixed a bug where progress wasn't being saved
* Fixed line height not having any effect due to not applying to children elements in the reader
* Fixed some wording for Refresh Covers confirmation
* Delete Series will now send an event to the UI informing that series was deleted.
* Change Progress widget to show Refreshing Covers for
* When we exit early due to potential missing folders/drives in a scan, tell the UI that scan is 100% done.
* Fixed manage library not supressing scan loader when a complete came in
* Fixed a spelling difference for Publication Status between filter and series detail
* Fixed a bug where collection detail page would flash on first load due to duplicate load events
* Added bookmarks to backups
* Fixed issues where fullscreen mode would break infinite scroller contiunous reader
* Added a lot of tests
* More tests! Added a Parser.NormalizePath to normalize all paths within Kavita.
* Fixed a bug where MarkChaptersAsUnread implementation wasn't consistent between different files and lead to extra row generation for no reason.
* Added more unit tests
* Found a better implementation for Natural Sorting. Added tests and validate it works. Next commit will swap out natural Sort for new Extension.
* Replaced NaturalSortComparer with OrderByNatural.
* Drastically simplified and sped up FindFirstEntry for finding cover images in archives
* Initial fix for a epub bug where metadata defines key as absolute path but document uses a relative path. We now have a hack to correct for the epub.
* Cleaned up a ton of warnings/suggestions from the IDE.
* Fixed a bug when clearing the filters some presets could be undone.
* Renamed a class in the OPDS spec
* Simplified logic for when Fit To Screen rendering logic occurs. It now works always rather than only on cover images.
* Give some additional info to the user on what the differences between Library Types are
* Don't scan .qpkg folders (QNAP devices)
* Refactored some code to enable ability to test CoverImage Test. This is a broken test, test.zip is waiting on an issue in NetVips.
* Fixed an issue where Extra might get flagged as special too early, if in a word like Extraordinary
* Cleaned up the regex for the extra issue to be more flexible
* Stashing code
* removed some debug code on series detail page. Now detail is collapsed by default.
* Added AgeRating
* Fixed a crash when NetVips tries to write a cover file and cover directory is not existing.
* When a card is selected for bulk actions, show an outline in addition to select box
* Added AgeRating into the metadata parsing. Added a hack where ComicInfo uses Number in ComicInfo rather than Volume. This is to test out the effects on users libraries.
* Added AgeRating and ReleaseDate to the metadata implelentation.
* Refactored all files to have Interfaces within the same file. Started moving over to file-scoped namespaces.
* Refactored common methods for getting underlying file's cover, pages, and extracting into 1 interface.
* More refactoring around removing dependence on explicit filetype testing for getting information.
* Code is buildable, tests are broken. Huge refactor (not completed) which makes most of DirectoryService testable with a mock filesystem (and thus the services that utilize it).
* Finished porting DirectoryService to use mocked filesystem implementation.
* Added a null check
* Added a null check
* Finished all unit tests for DirectoryService.
* Some misc cleanup on the code
* Fixed up some bugs from refactoring scan loop.
* Implemented CleanupService testing and refactored more of DirectoryService to be non-static.
Fixed a bug where cover file cleanup wasn't properly finding files due to a regex bug.
* Fixed an issue in CleanupBackup() where we weren't properly selecting database files older than 30 days. Finished CleanupService Tests.
* Refactored Flatten and RemoveNonImages to directory service to allow CacheService to be testable.
* Finally have CacheService tested. Rewrote GetCachedPagePath() to be much more straightforward & performant.
* Updated DefaultParserTests.cs to contain all existing tests and follow new test layout format.
* All tests fixed up
* Started with some basic plumbing with comic info parsing updating Series/Volume.
* We can now get chapter title from comicInfo.xml
* Hooked in the ability to store people into the chapter metadata.
* Removed no longer used imports, fixed up some foreign key constraints on deleting series with person linked.
* Refactored Summary out of the UI for Series into SeriesMetadata. Updated application to .net 6. There is a bug in metadata code for updating.
* Removed the parallel.ForEach with a normal foreach which lets us use async. For I/O heavy code, shouldn't change much.
* Refactored scan code to only check extensions with comic info, fixed a bug on scan events not using correct method name, removed summary field (still buggy)
* Fixed a bug where on cancelling a metadata request in modal, underlying button would get stuck in a disabled state.
* Changed how metadata selects the first volume to read summary info from. It will now select the first non-special volume rather than Volume 1.
* More debugging and found more bugs to fix
* Redid all the migrations as one single one. Fixed a bug with GetChapterInfo returning null when ChapterMetadata didn't exist for that Chapter.
Fixed an issue with mapper failing on GetChapterMetadata. Started work on adding people and a design for people.
* Fixed a bug where checking if file modified now takes into account if file has been processed at least once. Introduced a bug in saving people to series.
* Just made code compilable again
* Fixed up code. Now people for series and chapters add correctly without any db issues.
* Things are working, but I'm not happy with how the management of Person is. I need to take into account that 1 person needs to map to an image and role is arbitrary.
* Started adding UI code to showcase chapter metadata
* Updated workflow to be .NET 6
* WIP of updating card detail to show the information more clearly and without so many if statements
* Removed ChatperMetadata and store on the Chapter itself. Much easier to use and less joins.
* Implemented Genre on SeriesMetadata level
* Genres and People are now removed from Series level if they are no longer on comicInfo
* PeopleHelper is done with unit tests. Everything is working.
* Unit tests in place for Genre Helper
* Starting on CacheHelper
* Finished tests for ShouldUpdateCoverImage. Fixed and added tests in ArchiveService/ScannerService.
* CacheHelper is fully tested
* Some DI cleanup
* Scanner Service now calls GetComicInfo for books. Added ability to update Series Sort name from metadata files (mainly epub as comicinfo doesn't have a field)
* Forgot to move a line of code
* SortName now populates from metadata (epub only, ComicInfo has no tags)
* Cards now show the chapter title name if it's set on hover, else will default back to title.
* Fixed a major issue with how MangaFiles were being updated with LastModified, which messed up our logic for avoiding refreshes.
* Woohoo, more tests and some refactors to be able to test more services wtih mock filesystem. Fixed an issue where SortName was getting set as first chapter, but the Series was in a group.
* Refactored the MangaFile creation code into the DbFactory where we also setup the first LastModified update.
* Has file changed bug is now finally fixed
* Remove dead genres, refactor genre to use title instead of name.
* Refactored out a directory from ShouldUpdateCoverImage() to keep the code clean
* Unit tests for ComicInfo on BookService.
* Refactored series detail into it's own component
* Series-detail now received refresh metadata events to refresh what's on screen
* Removed references to Artist on PersonRole as it has no metadata mapping
* Security audit
* Fixed a benchmark
* Updated JWT Token generator to use new methods in .NET 6
* Updated all the docker and build commands to use net6.0
* Commented out sonar scan since it's not setup for net6.0 yet.
* Ensure Kavita knows about forwarding headers (fixes issue with epub urls not going through https with reverse proxy). Fixed a case where cover image selection preferred nested folders vs files in root directory.
* Fixed broken unit test
* Added bug that I fixed to the unit tests
* Implemented methods to parse out the whole ComicInfo file and a mock ComicInfo from epub files.
* Removed unused imports. ScanSeries needs to cleanup deleted chapters and call RefreshMetadata. Ensure after scan we cleanup tags without any series.
* Random cleanup
* Added some comments about data getting stale and not updating.
* Removed old Summary methods in favor of the ComicInfo versions
* Added a missing property
* Fixed unit test
* Updating wording on card item when total pages is 0, to be just "Cannot Read" since it could be a non-archive file
* Refactored cover images to be stored on disk. This first commit has the extraction to disk and the metadata service to handle updating when applicable.
* Refactored code to have the actual save to cover image directory done by ImageService.
* Implemented the ability to override cover images.
* Some cleanup on Image service
* Implemented the ability to cleanup old covers nightly
* Added a migration to migrate existing covers to new cover image format (files).
* Refactored all CoverImages to just be the filename, leaving the Join with Cover directory to higher level code.
* Ensure when getting user progress, we pick the first.
* Added cleanup cover images for deleted tags. Don't pull any cover images that are blank.
* After series update, clear out cover image. No change on UI, but just keeps things clear before metadata refresh hits
* Refactored image formats for covers to ImageService.
* Fixed an issue where after refactoring how images were stored, the cleanup service was deleting them after each scan.
* Changed how ShouldUpdateCoverImage works to check if file exists or not even if cover image is locked.
* Fixed unit tests
* Added caching back to cover images.
* Caching on series as well
* Code Cleanup items
* Ensure when checking if a file exists in MetadataService, that we join for cover image directory. After we scan library, do one last filter to delete any series that have 0 pages total.
* Catch exceptions so we don't run cover migration if this is first time run.
* After a scan, only clear out the cache directory and not do a deep clean.
* Implemented the ability to backup custom locked covers only.
* Fixed unit tests
* Trying to figure out why GA crashes when running MetadataServiceTests.cs
* Some debugging on GA tests not running
* Commented out tests that were causing issues in GA.
* Fixed an issue where series cover images wouldn't migrate
* Fixed the updating of links to actually do all series and not just locked
* Implemented the ability to download files (series, volume, chapter)
* Added RBS checks to ensure user is either an admin or has download role
* Added the ability to change a users feature RBS. Changed the Role seed to use reflection
* Fix directory issue when building all the packages where directory got skewed. (#98)
* Bump version for patch release due to bug in continue fuctionality. (#104)
* Chore/version bump (#106)
* Bump version for patch release due to bug in continue fuctionality.
* Added develop branch for github actions
* Updated readme to have an image and support link. (#107)
* Feature/readme (#109)
* Updated readme to have an image and support link.
* Updated readme
* Fixed a bug where if a chapter had multiple archive files, they wouldn't all be extracted due to short circuit in ExtractArchive. Now I add the file id then flatten afterwards. (#113)
* Bugfix/multiple file extract (#116)
* Fixed a bug where if a chapter had multiple archive files, they wouldn't all be extracted due to short circuit in ExtractArchive. Now I add the file id then flatten afterwards.
* Fixed a bug where due to how we were extracting for multiple files, the single file extractions failed.
* Bumped release for 3.5 release
* Comic Support (#119)
* Implemented some basic regex for comic support
* Implemented support for comics
* empty filenames, like .test.jpg shouldn't be counted as image types.
* Fixed some regex for Manga's with commas or version tags in parenthesis.
* More cases for parsing regex
* Lots of Parsing Enhancements (#120)
* More cases for parsing regex
* Implemented the ability to parse "Special" keywords.
* Commented out some unit tests
* More parsing cases
* Fixed unit tests
* Fixed typo in build script
* Parsing Enhancements (#126)
* More cases for parsing regex
* Implemented the ability to parse "Special" keywords.
* Commented out some unit tests
* More parsing cases
* Fixed unit tests
* Fixed typo in build script
* Fixed a bug where if there was a series with same name, but different capitalization, we wouldn't process it's infos.
* Tons of regex updates to handle more cases.
* More regex tweaking to handle as many cases as possible.
* Bad merge caused the comic parser to break. Fixed with some better regex.
* Parser Enhancement: Fallback to Folder name (#129)
* More cases for parsing regex
* Implemented GetFoldersTillRoot for falling back on parsing when we can't get anything from the filename.
* Implemented a fallback strategy. Not tested on large libraries yet.
* Fallback tested and working great.
* Removed a test case that won't pass and added some trims
* Update README.md
Added build steps
* Update README.md (#130)
Added docker link
* Special Grouping (#134)
* More cases for parsing regex
* Implemented a change to fix old special grouping. Added some TODOs as well for a future enhancement
* Don't go to archive file if it hasn't updated since last scan (#135)
* Skip archive work unless the file has actually changed since last scan.
* In Progress Activity Stream Fixes (#136)
* Fixed a bug in In-Progress where it wasn't properly fetching series.
* Fixed a bug where chapter cover images weren't being updated due to a missed not.
* Removed a piece of code that was needed for upgrading, since all beta users agreed to wipe db.
* Fixed InProgress to properly respect order and show more recent activity first. Issue is with IEntityDate LastModified not updating in DataContext.
* Updated dependencies to lastest stable.
* LastModified on Volumes wasn't updating, validated it does update when data is changed.
* In Progress Query Update (#145)
* Fixed a bug where chapter cover images weren't being updated due to a missed not.
* Removed a piece of code that was needed for upgrading, since all beta users agreed to wipe db.
* Fixed InProgress to properly respect order and show more recent activity first. Issue is with IEntityDate LastModified not updating in DataContext.
* Updated dependencies to lastest stable.
* LastModified on Volumes wasn't updating, validated it does update when data is changed.
* Performance, Scan Loop, Specials, and cleanup (#150)
* More cases for parsing regex
* Fixed a bug where chapter cover images weren't being updated due to a missed not.
* Removed a piece of code that was needed for upgrading, since all beta users agreed to wipe db.
* Fixed InProgress to properly respect order and show more recent activity first. Issue is with IEntityDate LastModified not updating in DataContext.
* Updated dependencies to lastest stable.
* LastModified on Volumes wasn't updating, validated it does update when data is changed.
* Rewrote a check to avoid a small heap object warning.
* Ensure UpdateSeries checks all libraries for unique name.
* Took care of some todos, removed unused imports, on dev go ahead and schedule reoocuring jobs since LiteDB caused the locking issue.
* No Tracking when we aren't using entities.
* Added code to remove abandoned progress rows after a chapter gets deleted.
* RefreshMetadata uses one large query rather than many trips to DB for updating metadata. Significantly faster.
* Fixed a bug where UpdateSeries would always complain about a unique name even when we weren't updating name.
* Files that are linked to a series but can't parse out Vol/Chapter information are properly grouped like other Specials.
* Refresh metadata on UI should call the task directly
* Fixed a bug on updating series to make sure we don't complain if we aren't trying to update the name to an existing name.
* Fixed#142 - Library cards should be sorted.
* Refactored the name of some variables to be more agnostic to comics.
* Implemented ScanLibrary but abandoning it.
* Code Cleanup & removing ScanSeries code.
* Some more tests and new Comparators for natural sorting.
* Fixed#137 - When performing I/O on archives, ignore __MACOSX folders completely.
* Fixed#137 - When performing I/O on archives, ignore __MACOSX folders completely.
* All entities that will show under specials tab should be marked special, rather than just what has a special keyword.
* Don't let specials generate cover images
* Don't let specials generate cover images
* SearchResults should send LocalizedName back since we are searching against it.
* Added some tests around macosx folders found from my actual server.
* Put extra notes about a case where duplicates come about, logger will now tell user about this issue.
* Missed a build issue somehow...
* Some code smells
* Bugfixes! (#157)
* More cases for parsing regex
* Fixed a bug where chapter cover images weren't being updated due to a missed not.
* Removed a piece of code that was needed for upgrading, since all beta users agreed to wipe db.
* Fixed InProgress to properly respect order and show more recent activity first. Issue is with IEntityDate LastModified not updating in DataContext.
* Updated dependencies to lastest stable.
* LastModified on Volumes wasn't updating, validated it does update when data is changed.
* Fixed#152 - Sorting issue when finding cover image.
* Fixed#151 - Sort files during scan.
* Fixed#161 - Remove files that don't exist from chapters during scan.
* Fixed#155 - Ignore images that start with !, expand cover detection by checking for the word cover as well as folder, and some code cleanup to make code more concise.
* Fixed#153 - Ensure that we persist series name changes and don't override on scanning.
* Fixed a broken unit test
* Version bump
* I keep fixing this but it keeps reverting (#158)
* Fixed#165 - Login and Registration will allow case-insensitive usernames now. (#169)
* Cover Image - First and tests (#170)
* Changed how natural sort works to cover more cases
* Changed the name of CoverImage regex for Parser and added more cases.
* Changed how we get result from Task.Run()
* Defer execution of a loop till we really need it and added another TODO for later this iteration.
* Big refactor to cover image code to unify between IOCompression and SharpCompress. Both use methods to find the correct file. This results in one extra loop through entries, but simplifies code signficantly.
In addition, new unit tests for the methods that actually do the logic on choosing cover file and first file.
* Removed dead code
* Added missing doc
* Feature/unit tests (#171)
* Removed a duplicate loop that was already done earlier in method.
* Normalize now replaces underscores
* Added more Parser cases, Added test case for SeriesExtension (Name in List), and added MergeNameTest and some TODOs for where tests should go
* Added a test for removal
* Fixed bad merge
Co-authored-by: Andrew Song <asong641@gmail.com>
* Feature/bugfix and regex (#174)
* Fixed#172
* Fixes#164
* Added a parse test for [Hidoi]_Amaenaideyo_MS_vol01_chp02.rar
* Fix annoying warning about SplitQuery on GetLibraryDtosForUsernameAsync
* Scan Bugfixes (#177)
* Added way more logging for debugging issue #163.
Fixed#175
* Removed some comment that isn't needed
* Fixed a enumeration issue due to removing while enumerating
* EPUB Support (#178)
* Added book filetype detection and reorganized tests due to size of file
* Added ability to get basic Parse Info from Book and Pages.
* We can now scan books and get them in a library with cover images.
* Take the first image in the epub if the cover isn't set.
* Implemented the ability to unzip the ebup to cache. Implemented a test api to load html files.
* Just some test code to figure out how to approach this.
* Fixed some merge conflicts
* Removed some dead code from merge
* Snapshot: I can now load everything properly into the UI by rewriting the urls before I send them back. I don't notice any lag from this method. It can be optimized further.
* Implemented a way to load the content in the browser not via an iframe.
* Added a note
* Anchor mappings is complete. New anchors are updated so references now resolve to javascript:void() for UI to take care of internally loading and the appropriate page is mapped to it. Anchors that are external have target="_blank" added so they don't force you out of the app and styles are of course inlined.
* Oops i need this
* Table of contents api implemented (rough) and some small enhancements to codebase for books.
* GetBookPageResources now only loads files from within the book. Nested chapter list support and images now use html parsing instead of string parsing.
* Fonts now are remapped to load from endpoint.
* book-resources now uses a key, ensuring the file is in proper format for lookup. Changed chapter list based on structure with one HEADER and nested chapters.
* Properly handle svg resource requests and when there are part anchors that are clickable, make sure we handle them in the UI by adding a kavita-page handler.
* Add Chapter group page even if one isn't set by using first page (without part) from nestedChildren.
* Added extra debug code for issue #163.
* Added new user preferences for books and updated the css so we scope it to our reading section.
* Cleaned up style code
* Implemented ability to save book preferences and some cleanup on existing apis.
* Added an api for checking if a user has read something in a library type before.
* Forgot to make sure the has reading progress is against a user lol.
* Remove cacheservice code for books, sine we use an in-memory method
* Handle svg images as well
* Enhanced cover image extraction to check for a "cover" image if the cover image wasn't set in OPF before falling back to the first image.
* Fixed an issue with special books not properly generating metadata due to not having filename set.
* Cleanup, removed warmup task code from statup/program and changed taskscheduler to schedule tasks on startup only (or if tasks are changed from UI).
* Code cleanup
* Code cleanup
* So much code. Lots of refactors to try to test scanner service. Moved a lot of the queries into Extensions to allow to easier test, even though it's hacky. Support @font-face src:url swaps with ' and ". Source summary information from epubs.
* Well...baseURL needs to come from BE and not from UI lol.
* Adjusted migrations so default values match Entity
* Removed comment
* I think I finally fixed#163! The issue was that when i checked if it had a parserInfo, i wasn't considering that the chapter range might have a - in it (0-6) and so when the code to check if range could parse out a number failed, it treated it like a special and checked range against info's filename.
* Some bugfixes
* Lots of testing, extracting code to make it easier to test. This code is buggy, but fixed a bug where 1) If we changed the normalization code, we would remove the whole db during a scan and 2) We weren't actually removing series properly.
Other than that, code is being extracted to remove duplication and centralize logic.
* More code cleanup and test cleanup to ensure scan loop is working as expected and matches expectaions from tests.
* Cleaned up the code and made it so if I change normalization, which I do in this branch, it wont break existing DBs.
* Some comic parser changes for partial chapter support.
* Added some code for directory service and scanner service along with python code to generate test files (not used yet). Fixed up all the tests.
* Code smells
* Book Feedback and small bugs (#183)
* Remove automatic retry for scanLibraries as if something fails, it wont pass magically. Catch exceptions when opening books for parsing and swallow to ignore the file.
* Delete extra attempts
* Switched to using FirstOrDefault for finding existing series. This will help avoid pointless crashes.
* Updated message when duplicate series are found (not sure how this happens)
* Fixed a negation for deleting volumes where files still exist.
* Implemented the ability to automatically scale the manga reader based on screen size.
* Feature/feedback (#185)
* Remove automatic retry for scanLibraries as if something fails, it wont pass magically. Catch exceptions when opening books for parsing and swallow to ignore the file.
* Delete extra attempts
* Switched to using FirstOrDefault for finding existing series. This will help avoid pointless crashes.
* Updated message when duplicate series are found (not sure how this happens)
* Fixed a negation for deleting volumes where files still exist.
* Implemented the ability to automatically scale the manga reader based on screen size.
* Default to automatic scaling
* Fix an issue where malformed epubs wouldn't be readable due to incorrect keys in the OPF. We now check if key is valid and if not, try to correct it. This makes a page load about a second on malformed books.
* Fixed#176. Refactored the recently added query to be restricted to user's access to libraries.
* Fixed a one off bug with In Progress series
* Implemented the ability to refresh metadata of just a single series directly
* Book Feedback (#190)
* Remove automatic retry for scanLibraries as if something fails, it wont pass magically. Catch exceptions when opening books for parsing and swallow to ignore the file.
* Delete extra attempts
* Switched to using FirstOrDefault for finding existing series. This will help avoid pointless crashes.
* Updated message when duplicate series are found (not sure how this happens)
* Fixed a negation for deleting volumes where files still exist.
* Implemented the ability to automatically scale the manga reader based on screen size.
* Default to automatic scaling
* Fix an issue where malformed epubs wouldn't be readable due to incorrect keys in the OPF. We now check if key is valid and if not, try to correct it. This makes a page load about a second on malformed books.
* Fixed#176. Refactored the recently added query to be restricted to user's access to libraries.
* Fixed a one off bug with In Progress series
* Implemented the ability to refresh metadata of just a single series directly
* Fixed a parser case where Series c000 (v01) would fail to parse the series
* Fixed#189. In Progress now returns data properly for library access and in multiple libraries.
* Fixed#188 by adding an extra message for bad login and updating UI
* Generate a fallback for table of contents by parsing the toc file (if we can find one)
* Bugfixes/misc (#196)
* Removed an error log statment which wasn't valid. Was showing error when a comicinfo.xml was not found in a directory.
* Fixed#191. Don't overwrite summary information if we already have something set from UI.
* Fixes#192
* Fixed#194 by moving the Take to after the query runs, so we take only distinct series.
* Added another case for Regex parsing for VanDread-v01-c01.zip
* Tap to Paginate User Pref (#197)
* Fixed In Progress and removed comments
* Tap to Paginate user setting is implemented. Fixes#193
* Implemented the ability to move between volumes (reading) automatically without existing the app. (#198)
* Feature/tech debt (#199)
* Added an icon for building the exe
* Technical debt
* Updated Readme for recruitment
* Regex addition (#200)
Co-authored-by: Andrew Song <asong641@gmail.com>
