Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update the documentation comply with the PHP license #240

Merged
merged 1 commit into from
Oct 23, 2024
Merged

chore: Update the documentation comply with the PHP license #240

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# Welcome to the PHP SDK Contributing Guide :wave:
# Welcome to the Momento SDK for PHP Contributing Guide :wave:

Thank you for taking your time to contribute to our PHP SDK!
Thank you for taking your time to contribute to our SDK!

This guide will provide you information to start your own development and testing.

Happy coding :dancer:

## Requirements

Check out our PHP SDK documentation for [requirements](https://docs.momentohq.com/sdks/php#requirements)!
Check out our SDK documentation for [requirements](https://docs.momentohq.com/sdks/php#requirements)!

## Build Docker Image

Expand All @@ -18,7 +18,7 @@ You will likely need to run this only once:
./dev-docker-build.sh
```

## Run Integration Test
## Run Integration Tests

```bash
export MOMENTO_API_KEY=<YOUR_API_KEY>
Expand Down
11 changes: 3 additions & 8 deletions README-logging.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,17 +1,12 @@
<head>
<meta name="Momento PHP Client Library Documentation" content="PHP client software development kit for Momento Serverless Cache">
</head>
<img src="https://docs.momentohq.com/img/logo.svg" alt="logo" width="400"/>
# Momento SDK Logging facilities

# Momento PHP SDK Logging facilities

The PHP SDK uses the [PSR-3](https://www.php-fig.org/psr/psr-3/) standard to allow the use of any compatible logging
The Momento SDK for PHP uses the [PSR-3](https://www.php-fig.org/psr/psr-3/) standard to allow the use of any compatible logging
implementation. This means you can either use your own favorite (PSR-3) logging package for the Momento client's logging
needs or you can use one provided by the SDK.

## SDK-provided logging

The Momento PHP SDK provides a few bare-bones logger factories to provide logging facilities for the client. The
The SDK provides a few bare-bones logger factories to provide logging facilities for the client. The
built-in logging factories include:

* Momento\Logging\StderrLoggerFactory - provides a logger that prints messages to stderr depending on the configured log level
Expand Down
2 changes: 0 additions & 2 deletions README-proxying.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
<img src="https://docs.momentohq.com/img/logo.svg" alt="logo" width="400"/>

# Using Momento With A Proxy

Momento `CacheClient` connections can be proxied with relative ease. We'll provide an example here, using
Expand Down
8 changes: 6 additions & 2 deletions README.template.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Japanese: [日本語](README.ja.md)

## Packages

The Momento PHP SDK package is available on packagist.org: [client-sdk-php](https://packagist.org/packages/momentohq/client-sdk-php)
The Momento SDK for PHP package is available on packagist.org: [client-sdk-php](https://packagist.org/packages/momentohq/client-sdk-php)

## Usage

Expand All @@ -20,11 +20,15 @@ Documentation is available on the [Momento Docs website](https://docs.momentohq.

## Examples

Working example projects, with all required build configuration files, are available
Working example projects, with all required build configuration files, are available
[in the examples directory](./examples/).

## Developing

If you are interested in contributing to the SDK, please see the [CONTRIBUTING](./CONTRIBUTING.md) docs.

## Attributions

This product includes PHP software, freely available from <http://www.php.net/software/>

{{ ossFooter }}
Loading