Skip to content

Commit 8022076

Browse files
committed
Engrish fixes on the readme
1 parent c850242 commit 8022076

File tree

1 file changed

+60
-60
lines changed

1 file changed

+60
-60
lines changed

README.md

Lines changed: 60 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -27,15 +27,15 @@ One Class uses for All Cache. You don't need to rewrite your code many times aga
2727
\* Driver descriptions available in DOCS/DRIVERS.md
2828

2929
### Symfony developers are not forgotten !
30-
Starting of the v5, phpFastCache comes with a [Symfony Bundle](https://github.com/PHPSocialNetwork/phpfastcache-bundle).
31-
He's fresh, so feel free to report any bug or contribute to the code using pull requests.
30+
Starting with v5, phpFastCache comes with a [Symfony Bundle](https://github.com/PHPSocialNetwork/phpfastcache-bundle).
31+
It's fresh, so feel free to report any bug or contribute to the project using pull requests.
3232

3333
---------------------------
3434
Not a "Traditional" Caching
3535
---------------------------
36-
phpFastCache is not a traditional caching method which keep read and write to files, sqlite or mass connections to memcache, redis, mongodb... Also, when you use Memcache / Memcached, your miss hits will be reduce.
37-
Different with normal caching methods which shared everywhere on internet, phpFastCache Lib reduce the high I/O load, and faster than traditional caching method at least x7 ~+ times.
38-
However, some time you still want to use traditional caching, we support them too.
36+
phpFastCache is not like the traditional caching methods which keep reading and writing to files, sqlite or keeping open massive amounts of connections to memcache, redis, mongodb... Also, when you use Memcache / Memcached, your miss hits will be reduced.
37+
Different from the usual caching methods you'll find everywhere on the internet, the phpFastCache library reduces high I/O load, and is faster than the traditional caching methods by at least ~7 times.
38+
However, when you still want to use traditional caching methods, we support them too.
3939

4040
```php
4141
use phpFastCache\CacheManager;
@@ -50,8 +50,8 @@ CacheManager::Files($config);
5050
Reduce Database Calls
5151
---------------------------
5252

53-
Your website have 10,000 visitors who are online, and your dynamic page have to send 10,000 same queries to database on every page load.
54-
With phpFastCache, your page only send 1 query to DB, and use the cache to serve 9,999 other visitors.
53+
Your website has 10,000 visitors who are online, and your dynamic page has to send 10,000 times the same queries to database on every page load.
54+
With phpFastCache, your page only sends 1 query to your DB, and uses the cache to serve the 9,999 other visitors.
5555

5656
---------------------------
5757
Rich Development API
@@ -60,68 +60,68 @@ Rich Development API
6060
phpFastCache offers you a lot of useful APIs:
6161

6262
### Item API
63-
- getKey() // Return the item identifier (key)
64-
- get() // The getter, obviously, return your cache object
65-
- set($value) // The setter, for those who missed it, put 0 meant cache it forever
66-
- expiresAfter($ttl) // Allow you to extends the lifetime of an entry without altering the value (formerly known as touch())
63+
- getKey() // Returns the item identifier (key)
64+
- get() // The getter, obviously, returns your cache object
65+
- set($value) // The setter, for those who missed it, putting 0 means cache it forever
66+
- expiresAfter($ttl) // Allows you to extends the lifetime of an entry without altering its value (formerly known as touch())
6767
- expiresAt($expiration) // Sets the expiration time for this cache item (as a DateTimeInterface object)
68-
- increment($step = 1) // For integer that we can count on
68+
- increment($step = 1) // To allow us to count on an integer item
6969
- decrement($step = 1) // Redundant joke...
70-
- append($data) // Append data to a string or an array (push)
71-
- prepend($data) // Prepend data to a string or an array (unshift)
72-
- isHit() // Check if your cache entry exists and is still valid, it is the equivalent of isset()
73-
- isExpired() // Check if your cache entry is expired
74-
- getTtl() // Get the remaining Time To Live as an integer
75-
- getExpirationDate() // Get the expiration date as a Datetime object
76-
- addTag($tagName) // Add a tag
77-
- addTags(array $tagNames) // Add many tags
78-
- setTags(array $tags) // Set some tags
79-
- getTags() // Get the tags
80-
- getTagsAsString($separator = ', ') // Get the data a string separated by $separator
81-
- removeTag($tagName) // Remove a tag
82-
- removeTags(array $tagNames) // Remove some tags
70+
- append($data) // Appends data to a string or an array (push)
71+
- prepend($data) // Prepends data to a string or an array (unshift)
72+
- isHit() // Checks if your cache entry exists and is still valid, it's the equivalent of isset()
73+
- isExpired() // Checks if your cache entry is expired
74+
- getTtl() // Gets the remaining Time To Live as an integer
75+
- getExpirationDate() // Gets the expiration date as a Datetime object
76+
- addTag($tagName) // Adds a tag
77+
- addTags(array $tagNames) // Adds multiple tags
78+
- setTags(array $tags) // Sets multiple tags
79+
- getTags() // Gets the tags
80+
- getTagsAsString($separator = ', ') // Gets the data as a string separated by $separator
81+
- removeTag($tagName) // Removes a tag
82+
- removeTags(array $tagNames) // Removes multiple tags
8383
- getDataAsJsonString()// Return the data as a well-formatted json string
8484
- setExpirationDate() // Alias of expireAt() (for more code logic)
85-
- getCreationDate() // Get the creation date for this cache item (as a DateTimeInterface object) *
86-
- getModificationDate() // Get the modification date for this cache item (as a DateTimeInterface object) *
87-
- setCreationDate($expiration) // Set the creation date for this cache item (as a DateTimeInterface object) *
88-
- setModificationDate($expiration) // Set the modification date for this cache item (as a DateTimeInterface object) *
89-
- setEventManager($evtMngr) // Set the event manager
85+
- getCreationDate() // Gets the creation date for this cache item (as a DateTimeInterface object) *
86+
- getModificationDate() // Gets the modification date for this cache item (as a DateTimeInterface object) *
87+
- setCreationDate($expiration) // Sets the creation date for this cache item (as a DateTimeInterface object) *
88+
- setModificationDate($expiration) // Sets the modification date for this cache item (as a DateTimeInterface object) *
89+
- setEventManager($evtMngr) // Sets the event manager
9090

9191
\* Require configuration directive "itemDetailedDate" to be enabled
9292

9393
### ItemPool API
94-
- getItem($key) // Retrieve an item and returns an empty item if not found
95-
- getItems(array $keys) // Retrieve one or more item and returns an array of items
94+
- getItem($key) // Retrieves an item and returns an empty item if not found
95+
- getItems(array $keys) // Retrieves one or more item and returns an array of items
9696
- getItemsAsJsonString(array $keys) // Returns A json string that represents an array of items
9797
- hasItem($key) // Tests if an item exists
98-
- deleteItem($key) // Delete an item
99-
- deleteItems(array $keys) // Delete one or more items
98+
- deleteItem($key) // Deletes an item
99+
- deleteItems(array $keys) // Deletes one or more items
100100
- save(CacheItemInterface $item) // Persists a cache item immediately
101101
- saveDeferred(CacheItemInterface $item); // Sets a cache item to be persisted later
102102
- commit(); // Persists any deferred cache items
103-
- clear() // Allow you to completely empty the cache and restart from the beginning
104-
- getStats() // Return the cache statistics as an object, useful for checking disk space used by the cache etc.
105-
- getItemsByTag($tagName) // Return items by a tag
106-
- getItemsByTags(array $tagNames) // Return items by some tags
107-
- getItemsByTagsAsJsonString(array $tagNames) // Returns A json string that represents an array of items by tags-based
108-
- deleteItemsByTag($tagName) // Delete items by a tag
109-
- deleteItemsByTags(array $tagNames) // Delete items by some tags
110-
- incrementItemsByTag($tagName, $step = 1) // Increment items by a tag
111-
- incrementItemsByTags(array $tagNames, $step = 1) // Increment items by some tags
112-
- decrementItemsByTag($tagName, $step = 1) // Decrement items by a tag
113-
- decrementItemsByTags(array $tagNames, $step = 1) // Decrement items by some tags
114-
- appendItemsByTag($tagName, $data) // Append items by a tag
115-
- appendItemsByTags(array $tagNames, $data) // Append items by some tags
116-
- prependItemsByTag($tagName, $data) // Prepend items by a tag
117-
- prependItemsByTags(array $tagNames, $data) // Prepend items by some tags
118-
- detachItem($item) // Detach an item from the pool
119-
- detachAllItems($item) // Detach all items from the pool
120-
- attachItem($item) // (Re-)attach an item to the pool
103+
- clear() // Allows you to completely empty the cache and restart from the beginning
104+
- getStats() // Returns the cache statistics as an object, useful for checking disk space used by the cache etc.
105+
- getItemsByTag($tagName) // Returns items by a tag
106+
- getItemsByTags(array $tagNames) // Returns items by multiple tags
107+
- getItemsByTagsAsJsonString(array $tagNames) // Returns A json string that represents an array of items corresponding to given tags
108+
- deleteItemsByTag($tagName) // Deletes items by a tag
109+
- deleteItemsByTags(array $tagNames) // Deletes items by multiple tags
110+
- incrementItemsByTag($tagName, $step = 1) // Increments items by a tag
111+
- incrementItemsByTags(array $tagNames, $step = 1) // Increments items by multiple tags
112+
- decrementItemsByTag($tagName, $step = 1) // Decrements items by a tag
113+
- decrementItemsByTags(array $tagNames, $step = 1) // Decrements items by multiple tags
114+
- appendItemsByTag($tagName, $data) // Appends items by a tag
115+
- appendItemsByTags(array $tagNames, $data) // Appends items by multiple tags
116+
- prependItemsByTag($tagName, $data) // Prepends items by a tag
117+
- prependItemsByTags(array $tagNames, $data) // Prepends items by multiple tags
118+
- detachItem($item) // Detaches an item from the pool
119+
- detachAllItems($item) // Detaches all items from the pool
120+
- attachItem($item) // (Re-)attaches an item to the pool
121121
- isAttached($item) // Verify if an item is (still) attached
122-
- setEventManager($evtMngr) // Set the event manager
122+
- setEventManager($evtMngr) // Sets the event manager
123123

124-
Also support Multiple calls, Tagging, Setup Folder for caching. Look at our examples folders.
124+
It also supports multiple calls, Tagging, Setup Folder for caching. Look at our examples folders for more information.
125125

126126
---------------------------
127127
Introducing to events
@@ -162,7 +162,7 @@ EventManager::getInstance()->unbindEventCallback('onCacheGetItem', 'myCallbackNa
162162

163163
```
164164

165-
More informations about the implementation and the events on the [Wiki](https://github.com/PHPSocialNetwork/phpfastcache/wiki/%5BV6%5D-Introducing-to-events)
165+
More information about the implementation and the events available on the [Wiki](https://github.com/PHPSocialNetwork/phpfastcache/wiki/%5BV6%5D-Introducing-to-events)
166166

167167
---------------------------
168168
As Fast To Implement As Opening a Beer
@@ -176,7 +176,7 @@ As Fast To Implement As Opening a Beer
176176
composer require phpFastCache/phpFastCache
177177
```
178178

179-
#### :construction: Step 2: Setup your website code to implements phpFastCache bits (With Composer)
179+
#### :construction: Step 2: Setup your website code to implement the phpFastCache calls (with Composer)
180180
```php
181181
use phpFastCache\CacheManager;
182182

@@ -215,7 +215,7 @@ if (is_null($CachedString->get())) {
215215
}
216216

217217
/**
218-
* use your products here or return it;
218+
* use your products here or return them;
219219
*/
220220
echo implode('<br />', $CachedString->get());// Will echo your product list
221221

@@ -224,8 +224,8 @@ echo implode('<br />', $CachedString->get());// Will echo your product list
224224
##### :floppy_disk: Legacy / Lazy Method (Without Composer)
225225
* See the file examples/withoutComposer.php for more information.
226226

227-
#### :zap: Step 3: Enjoy ! Your website is now faster than flash !
228-
For curious developpers, there is a lot of others available examples [here](https://github.com/PHPSocialNetwork/phpfastcache/tree/final/examples).
227+
#### :zap: Step 3: Enjoy ! Your website is now faster than lightning !
228+
For curious developpers, there is a lot of other examples available [here](https://github.com/PHPSocialNetwork/phpfastcache/tree/final/examples).
229229

230230
#### :boom: phpFastCache support
231-
Found an issue or had an idea ? Come [here](https://github.com/PHPSocialNetwork/phpfastcache/issues) and let us know !
231+
Found an issue or have an idea ? Come [here](https://github.com/PHPSocialNetwork/phpfastcache/issues) and let us know !

0 commit comments

Comments
 (0)