diff --git a/README.md b/README.md index 3f64caa..636305a 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,26 @@ # com.pixelwizards.objectpool + Object pooling system for Unity. + +Documentation is online: +https://www.megacrush.app/api/object-pool + +No editor-facing functionality. + +Create new Object pools with: + +GameObject prefab; + +PoolManager.AddNewObjectPool(new PoolObjectSetting() +{ + count = 10, + prefab = prefab, +}); + +Get an instance from the Pool: + +var instance = PoolManager.GetInstance(prefab); + +Return the Instance to the Pool: + +PoolManager.ReturnInstance(thisObject); diff --git a/package.json b/package.json index 7884364..defd2e5 100644 --- a/package.json +++ b/package.json @@ -3,7 +3,7 @@ "displayName": "Object Pooling", "version": "1.0.0", "unity": "2018.4", - "description": "Powerful Object Pooling system.", + "description": "Powerful Object Pooling system.\n\nDocumentation is online: \nhttps://www.megacrush.app/api/object-pool\n\nNo editor-facing functionality.", "category": null, "author": { "name": "Megacrush Interactive",