Initial version extracted from Recyclable.Collections

README.md

@@ -1 +1,22 @@
-# Recyclable.Collections.Compatibility.List
+# Recyclable.Collections.Compatibility.List# Recyclable.Collections
+`Recyclable.Collections.Compatibility.List` project is an open source add-on for [Recyclable.Collections](https://github.com/mlemanczyk/Recyclable.Collections) providing `List<T>` compatibility features to the recyclable collections framework.
+
+## Included compatibility packs
+* `RecyclableList<T>`
+
+# Milestones
+1. 👉 Implement compatibility pack
+	1. ✅ `RecyclableList<T>`
+	1. 👉 `RecyclableLongList<T>`
+	1. 🅿️ `RecyclableQueue<T>`
+	1. 🅿️ `RecyclableSortedList<T>`
+	1. 🅿️ `RecyclableStack<T>`
+	1. 🅿️ `RecyclableUnorderedList<T>`
+1. 🅿️ Review performance
+1. 🅿️ Optimize performance
+
+# Characteristics of the classes
+The package 
+
+## Common
+* All classes will internally or externally utilize [Recyclable.Collections](https://github.com/mlemanczyk/Recyclable.Collections) to benefit from recyclable memory pools.