Skip to content

Commit

Permalink
Update READMEs
Browse files Browse the repository at this point in the history
  • Loading branch information
hermanwikner committed Dec 8, 2022
1 parent 5abfecc commit 4eb6915
Show file tree
Hide file tree
Showing 2 changed files with 125 additions and 18 deletions.
39 changes: 22 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,26 +16,31 @@
</a>
</p>

## Build with Structured Content
## Build powerful production-ready content workspaces

> **Sanity.io is the platform for structured content. It comes with an open-source editing environment called Sanity Studio that you can customize with JavaScript and a real-time hosted data store. Sanity has generous included quotas – so [getting started](https://www.sanity.io/get-started) is free.**
> The Sanity Composable Content Cloud lets teams create remarkable digital experiences at scale. Sanity Studio is an open-source, single-page application that is fast to set up and quick to configure. The Studio comes with a complete studio customization framework that lets you tailor the workspace as your needs grow.
>
> Sanity hosts your content in a real-time, hosted data store called Content Lake. [Get started](https://www.sanity.io/get-started) with the free plan with generous bandwidth and hosting included and pay-as-you-go for overages.
## Quickstart

Get started from the command line:
Initiate a new project by running the following command:

```bash
npm i -g @sanity/cli && sanity init
npm create sanity@latest

# With other package managers:
yarn create sanity@latest
pnpm create sanity@latest
```

Or go to [sanity.io/get-started](https://www.sanity.io/get-started) to get started from the browser in minutes.
[Go here](https://www.sanity.io/docs/getting-started-with-sanity) for a step-by-step guide on how to get up and running.

- Watch the [getting started video on YouTube](https://www.youtube.com/watch?v=2ceM_tSus_M&lc=z224vtt5nqq1cbcf2acdp43aylzlb5jhft1kmuafltxw03c010c).
- Check out our [guides](https://www.sanity.io/guides) and [plugins](https://www.sanity.io/plugins) and start building.
Check out [the docs](https://www.sanity.io/docs/sanity-studio) and [plugins](https://www.sanity.io/plugins) and start building.

## Table of contents

- [Build with Structured Content](#build-with-structured-content)
- [Build powerful production-ready content workspaces](#build-powerful-production-ready-content-workspaces)
- [Quickstart](#quickstart)
- [Table of contents](#table-of-contents)
- [Key Features](#key-features)
Expand All @@ -49,18 +54,18 @@ Or go to [sanity.io/get-started](https://www.sanity.io/get-started) to get start

## Key Features

![Sanity Studio](https://cdn.sanity.io/images/3do82whm/next/f31379d654eabc2feb5c0226510fce1195a0b3bd-2680x1506.png?w=1200&fit=max&auto=format)
![Sanity Studio](https://cdn.sanity.io/images/3do82whm/next/634bd76e8333f9c824a3f09ff563b5373bcfac3a-7684x4322.png?w=2000&fit=max&auto=format&dpr=2)

### [Sanity Studio](https://www.sanity.io/studio)

[Sanity Studio](https://www.sanity.io/studio) is an open source headless real-time CMS, that you can customize with JavaScript and React.
[Sanity Studio](https://www.sanity.io/studio) is an open-source real-time CMS, that you can customize with JavaScript and React.

- Efficient editing, instant UI for complex fields.
- Responsive, works on small screens.
- [Plug-in architecture](https://www.sanity.io/plugins) and [custom input components](https://www.sanity.io/guides/how-to-make-a-custom-input-component).
- [Style with your own branding](https://www.sanity.io/guides/how-to-brand-your-studio).
- [Advanced block editor for structured content](https://www.sanity.io/docs/block-content).
- Use JavaScript to add [field validations](https://www.sanity.io/docs/validation), [organize documents](https://www.sanity.io/docs/overview-structure-builder), and set [initial values](https://www.sanity.io/guides/getting-started-with-initial-values-for-new-documents).
- Efficient editing, instant UI for complex fields
- Responsive, works on narrow screens
- [Plug-in architecture](https://www.sanity.io/plugins) and [custom components](https://www.sanity.io/docs/component-api)
- [Style with your own branding](https://www.sanity.io/docs/theming)
- [Advanced block editor for structured content](https://www.sanity.io/docs/block-content)
- Use JavaScript to add [field validations](https://www.sanity.io/docs/validation), [organize documents](https://www.sanity.io/docs/overview-structure-builder), and set [initial values](https://www.sanity.io/docs/theming)

### [Developer experience](https://www.sanity.io/developer-experience)

Expand All @@ -80,7 +85,7 @@ Or go to [sanity.io/get-started](https://www.sanity.io/get-started) to get start

## Stay up to date

- Follow **@sanity_io** on [twitter](https://twitter.com/sanity_io)
- Follow **@sanity_io** on [Twitter](https://twitter.com/sanity_io)
- Subscribe to [our blog by RSS](https://www.sanity.io/feed/rss)
- Subscribe to our [newsletter](http://eepurl.com/b2yaDz)
- Join the [developer community on Slack](https://slack.sanity.io)
Expand Down
104 changes: 103 additions & 1 deletion packages/sanity/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,103 @@
This is the new Sanity entry file. Readme to come.
<p align="center">
<a href="https://sanity.io">
<img src="https://cdn.sanity.io/images/3do82whm/next/51af00784c5addcf63ae7f0c416756acca7e63ac-353x71.svg?w=400&fm=png&fit=max">
</a>
</p>

<p align="center">
<img alt="" src="https://img.shields.io/npm/v/sanity">
<img alt="" src="https://img.shields.io/npm/dm/@sanity/client">
<img alt="" src="https://img.shields.io/npm/l/@sanity/client.svg">
<a aria-label="Join the community on Slack" href="https://slack.sanity.io">
<img alt="" src="https://img.shields.io/badge/Join%20Slack-f03e2f?logo=Slack">
</a>
<a aria-label="Follow Sanity on Twitter" href="https://twitter.com/sanity_io">
<img alt="" src="https://img.shields.io/twitter/follow/sanity_io?style=flat&color=blue">
</a>
</p>

## Build powerful production-ready content workspaces

> The Sanity Composable Content Cloud lets teams create remarkable digital experiences at scale. Sanity Studio is an open-source, single-page application that is fast to set up and quick to configure. The Studio comes with a complete studio customization framework that lets you tailor the workspace as your needs grow.
>
> Sanity hosts your content in a real-time, hosted data store called Content Lake. [Get started](https://www.sanity.io/get-started) with the free plan with generous bandwidth and hosting included and pay-as-you-go for overages.
## Quickstart

Initiate a new project by running the following command:

```bash
npm create sanity@latest

# With other package managers:
yarn create sanity@latest
pnpm create sanity@latest
```

[Go here](https://www.sanity.io/docs/getting-started-with-sanity) for a step-by-step guide on how to get up and running.

Check out [the docs](https://www.sanity.io/docs/sanity-studio) and [plugins](https://www.sanity.io/plugins) and start building.

## Table of contents

- [Build powerful production-ready content workspaces](#build-powerful-production-ready-content-workspaces)
- [Quickstart](#quickstart)
- [Table of contents](#table-of-contents)
- [Key Features](#key-features)
- [Sanity Studio](#sanity-studio)
- [Developer experience](#developer-experience)
- [Structured Content](#structured-content)
- [Stay up to date](#stay-up-to-date)
- [Code of Conduct](#code-of-conduct)
- [Want to contribute?](#want-to-contribute)
- [License](#license)

## Key Features

![Sanity Studio](https://cdn.sanity.io/images/3do82whm/next/634bd76e8333f9c824a3f09ff563b5373bcfac3a-7684x4322.png?w=2000&fit=max&auto=format&dpr=2)

### [Sanity Studio](https://www.sanity.io/studio)

[Sanity Studio](https://www.sanity.io/studio) is an open-source real-time CMS, that you can customize with JavaScript and React.

- Efficient editing, instant UI for complex fields
- Responsive, works on narrow screens
- [Plug-in architecture](https://www.sanity.io/plugins) and [custom components](https://www.sanity.io/docs/component-api)
- [Style with your own branding](https://www.sanity.io/docs/theming)
- [Advanced block editor for structured content](https://www.sanity.io/docs/block-content)
- Use JavaScript to add [field validations](https://www.sanity.io/docs/validation), [organize documents](https://www.sanity.io/docs/overview-structure-builder), and set [initial values](https://www.sanity.io/docs/theming)

### [Developer experience](https://www.sanity.io/developer-experience)

- [Bring your own frontend, or whatever else you might need](https://www.sanity.io/docs/build-with-sanity).
- [Sweet APIs for reading, writing, importing, exporting, go back in time, and listening for updates](https://www.sanity.io/docs/datastore).
- [Secure, scalable and GDPR compliant](https://www.sanity.io/security).
- [Zero config Graph Oriented Query Language (GROQ)](https://www.sanity.io/docs/how-queries-work), and [GraphQL API](https://www.sanity.io/docs/graphql).
- [Helpful and friendly developer community](https://slack.sanity.io).

### [Structured Content](https://www.sanity.io/structured-content)

- Distribute from a single source of truth, in real-time.
- Unlock programmatic approaches to workflows and design.
- [Upload images and transform them on demand](https://www.sanity.io/docs/asset-pipeline).
- Query images for metadata like dominant colors, sizes, geo-location, and EXIF metadata.
- [Rich text that can be serialized into any markup language](https://www.sanity.io/guides/introduction-to-portable-text).

## Stay up to date

- Follow **@sanity_io** on [Twitter](https://twitter.com/sanity_io)
- Subscribe to [our blog by RSS](https://www.sanity.io/feed/rss)
- Subscribe to our [newsletter](http://eepurl.com/b2yaDz)
- Join the [developer community on Slack](https://slack.sanity.io)

## Code of Conduct

We aim to be an inclusive, welcoming community for everyone. To make that explicit, we have a [code of conduct](https://github.com/sanity-io/sanity/blob/current/CODE_OF_CONDUCT.md) that applies to communication around the project.

## Want to contribute?

Found a bug, or want to contribute code? Pull requests and issues are most welcome. Read our [contributing guidelines](https://github.com/sanity-io/sanity/blob/current/CONTRIBUTING.md) to learn how.

## License

Sanity Studio is available under the [_MIT License_](https://github.com/sanity-io/sanity/blob/current/LICENSE)

1 comment on commit 4eb6915

@vercel
Copy link

@vercel vercel bot commented on 4eb6915 Dec 8, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Successfully deployed to the following URLs:

test-studio – ./

test-studio.sanity.build
test-studio-git-next.sanity.build

Please sign in to comment.